{ "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 System", "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": "telemetry" }, { "name": "aaa" }, { "name": "apiproxy" }, { "name": "appliance" }, { "name": "asset" }, { "name": "auditd" }, { "name": "blueprint" }, { "name": "bulk" }, { "name": "cli" }, { "name": "cloud" }, { "name": "cmrf" }, { "name": "cond" }, { "name": "connector" }, { "name": "content" }, { "name": "coremanagement" }, { "name": "externalsite" }, { "name": "feedback" }, { "name": "filterexpr" }, { "name": "hci" }, { "name": "hcl" }, { "name": "i18n" }, { "name": "iam" }, { "name": "imcconnector" }, { "name": "infra" }, { "name": "issue" }, { "name": "iwotenant" }, { "name": "license" }, { "name": "meta" }, { "name": "metric" }, { "name": "metrics" }, { "name": "mgmt" }, { "name": "mo" }, { "name": "monitoring" }, { "name": "motemplate" }, { "name": "notification" }, { "name": "oauth" }, { "name": "onprem" }, { "name": "openapi" }, { "name": "oprs" }, { "name": "organization" }, { "name": "partnerintegration" }, { "name": "pkix" }, { "name": "policy" }, { "name": "pool" }, { "name": "recovery" }, { "name": "resource" }, { "name": "resourcepool" }, { "name": "rproxy" }, { "name": "scheduler" }, { "name": "sdaaci" }, { "name": "serviceitem" }, { "name": "servicerequest" }, { "name": "session" }, { "name": "software" }, { "name": "softwarerepository" }, { "name": "sw" }, { "name": "task" }, { "name": "techsupportmanagement" }, { "name": "template" }, { "name": "top" }, { "name": "tunneling" }, { "name": "ucsdconnector" }, { "name": "view" }, { "name": "workload" }, { "name": "x509" } ], "paths": { "/api/v1/telemetry/TimeSeries": { "post": { "tags": [ "telemetry" ], "summary": "Perform a Druid TimeSeries request.", "operationId": "QueryTelemetryTimeSeries", "description": "Endpoint that exposes Druid requests for time series data. This endpoint exposes specifically TimeSeries requests and broker information.", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.telemetry.TimeSeries", "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Read-Only", "ROLE.Server Administrator" ] } ], "requestBody": { "description": "The Druid request schema for time series queries.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidTimeSeriesRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the Druid request has been fullfilled.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "description": "The Druid time series aggregate response.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidIntervalResult" } } } } }, "default": { "description": "The error response when a Druid query fails.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidError" } } } } } } }, "/api/v1/telemetry/Topns": { "post": { "tags": [ "telemetry" ], "summary": "Perform a Druid TopN request.", "operationId": "QueryTelemetryTopN", "description": "Endpoint that exposes Druid TopN requests for time series data.", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.telemetry.TimeSeries", "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Read-Only", "ROLE.Server Administrator" ] } ], "requestBody": { "description": "The Druid request schema for time series queries.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidTopNRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the Druid request has been fullfilled.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "description": "The Druid time series aggregate response.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidTopNResult" } } } } }, "default": { "description": "The error response when a Druid query fails.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidError" } } } } } } }, "/api/v1/telemetry/GroupBys": { "post": { "tags": [ "telemetry" ], "summary": "Perform a Druid GroupBy request.", "operationId": "QueryTelemetryGroupBy", "description": "Endpoint that exposes Druid GroupBy requests for time series data.", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.telemetry.TimeSeries", "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Read-Only", "ROLE.Server Administrator" ] } ], "requestBody": { "description": "The Druid request schema for time series queries.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidGroupByRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the Druid request has been fullfilled.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "description": "The Druid time series aggregate response.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidGroupByResult" } } } } }, "default": { "description": "The error response when a Druid query fails.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidError" } } } } } } }, "/api/v1/telemetry/Scans": { "post": { "tags": [ "telemetry" ], "summary": "Perform a Druid Scan request.", "operationId": "QueryTelemetryScan", "description": "Endpoint that exposes Druid Scan requests for time series data.", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.telemetry.TimeSeries", "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Read-Only", "ROLE.Server Administrator" ] } ], "requestBody": { "description": "The Druid request schema for time series queries.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidScanRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the Druid request has been fullfilled.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "description": "The Druid scan response payload.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidScanResult" } } } } }, "default": { "description": "The error response when a Druid query fails.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidError" } } } } } } }, "/api/v1/telemetry/Searches": { "post": { "tags": [ "telemetry" ], "summary": "Perform a Druid Search request.", "operationId": "QueryTelemetrySearch", "description": "Endpoint that exposes Druid Search requests for time series data.", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.telemetry.TimeSeries", "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Read-Only", "ROLE.Server Administrator" ] } ], "requestBody": { "description": "The Druid request schema for time series queries.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidSearchRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the Druid request has been fullfilled.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "description": "The Druid time series aggregate response.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidSearchResult" } } } } }, "default": { "description": "The error response when a Druid query fails.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidError" } } } } } } }, "/api/v1/telemetry/TimeBoundaries": { "post": { "tags": [ "telemetry" ], "summary": "Perform a Druid TimeBoundary request.", "operationId": "QueryTelemetryTimeBoundary", "description": "Endpoint that exposes Druid TimeBoundary requests for time series data.", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.telemetry.TimeSeries", "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Read-Only", "ROLE.Server Administrator" ] } ], "requestBody": { "description": "The Druid request schema for time series queries.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidTimeBoundaryRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the Druid request has been fullfilled.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "description": "The Druid time series aggregate response.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidTimeBoundaryResult" } } } } }, "default": { "description": "The error response when a Druid query fails.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidError" } } } } } } }, "/api/v1/telemetry/SegmentMetadata": { "post": { "tags": [ "telemetry" ], "summary": "Perform a Druid SegmentMetadata request.", "operationId": "QueryTelemetrySegmentMetadata", "description": "Endpoint that exposes Druid SegmentMetadata requests for time series data.", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.telemetry.TimeSeries", "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Read-Only", "ROLE.Server Administrator" ] } ], "requestBody": { "description": "The Druid request schema for time series queries.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidSegmentMetadataRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the Druid request has been fullfilled.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "description": "The Druid time series aggregate response.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidSegmentMetadataResult" } } } } }, "default": { "description": "The error response when a Druid query fails.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidError" } } } } } } }, "/api/v1/telemetry/DataSourceMetadata": { "post": { "tags": [ "telemetry" ], "summary": "Perform a Druid DatasourceMetadata request.", "operationId": "QueryTelemetryDatasourceMetadata", "description": "Endpoint that exposes Druid DatasourceMetadata requests for time series data.", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.telemetry.TimeSeries", "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Read-Only", "ROLE.Server Administrator" ] } ], "requestBody": { "description": "The Druid request schema for time series queries.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidDataSourceMetadataRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the Druid request has been fullfilled.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "description": "The Druid time series aggregate response.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidDataSourceMetadataResult" } } } } }, "default": { "description": "The error response when a Druid query fails.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/telemetry.DruidError" } } } } } } }, "/api/v1/search/SuggestItems": { "post": { "tags": [ "search" ], "summary": "Create a 'search.SuggestItem' resource.", "operationId": "CreateSearchSuggestItem", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.search.SuggestItem" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'search.SuggestItem' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search.SuggestItem" } } } }, "responses": { "200": { "description": "List of 'search.SuggestItem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search.SuggestItem.Response" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/AuditRecords": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.AuditRecord' resource.", "operationId": "GetAaaAuditRecordList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Monitor audit logs", "PRIVSET.Read-only all audit logs", "PRIVSET.View Audit Logs", "READ.aaa.AuditRecord", "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 'aaa.AuditRecord' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.AuditRecord.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/AuditRecords/{Moid}": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.AuditRecord' resource.", "operationId": "GetAaaAuditRecordByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Monitor audit logs", "PRIVSET.Read-only all audit logs", "PRIVSET.View Audit Logs", "READ.aaa.AuditRecord", "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 'aaa.AuditRecord' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.AuditRecord" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAaaAuditRecordByMoid": { "operationId": "GetAaaAuditRecordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/AuditRecords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/RetentionConfigs": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.RetentionConfig' resource.", "operationId": "GetAaaRetentionConfigList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Monitor audit logs", "PRIVSET.Read-Only", "PRIVSET.View Audit Logs", "READ.aaa.RetentionConfig", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'aaa.RetentionConfig' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionConfig.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/RetentionConfigs/{Moid}": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.RetentionConfig' resource.", "operationId": "GetAaaRetentionConfigByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Monitor audit logs", "PRIVSET.Read-Only", "PRIVSET.View Audit Logs", "READ.aaa.RetentionConfig", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'aaa.RetentionConfig' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionConfig" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAaaRetentionConfigByMoid": { "operationId": "GetAaaRetentionConfigByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionConfigs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/RetentionPolicies": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.RetentionPolicy' resource.", "operationId": "GetAaaRetentionPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Monitor audit logs", "PRIVSET.Read-Only", "PRIVSET.Read-only all audit logs", "PRIVSET.View Audit Logs", "READ.aaa.RetentionPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'aaa.RetentionPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "aaa" ], "summary": "Create a 'aaa.RetentionPolicy' resource.", "operationId": "CreateAaaRetentionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.aaa.RetentionPolicy", "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'aaa.RetentionPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'aaa.RetentionPolicy' resource was created as requested. The 'aaa.RetentionPolicy' 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/aaa.RetentionPolicy" } } }, "links": { "GetAaaRetentionPolicyByMoid": { "operationId": "GetAaaRetentionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/aaa/RetentionPolicies/{Moid}": { "get": { "tags": [ "aaa" ], "summary": "Read a 'aaa.RetentionPolicy' resource.", "operationId": "GetAaaRetentionPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Monitor audit logs", "PRIVSET.Read-Only", "PRIVSET.Read-only all audit logs", "PRIVSET.View Audit Logs", "READ.aaa.RetentionPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'aaa.RetentionPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAaaRetentionPolicyByMoid": { "operationId": "GetAaaRetentionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "aaa" ], "summary": "Update a 'aaa.RetentionPolicy' resource.", "operationId": "UpdateAaaRetentionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator", "UPDATE.aaa.RetentionPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'aaa.RetentionPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'aaa.RetentionPolicy' resource was modified as requested. The 'aaa.RetentionPolicy' 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/aaa.RetentionPolicy" } } }, "links": { "GetAaaRetentionPolicyByMoid": { "operationId": "GetAaaRetentionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "aaa" ], "summary": "Update a 'aaa.RetentionPolicy' resource.", "operationId": "PatchAaaRetentionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator", "UPDATE.aaa.RetentionPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'aaa.RetentionPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aaa.RetentionPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'aaa.RetentionPolicy' resource was patched as requested. The 'aaa.RetentionPolicy' 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/aaa.RetentionPolicy" } } }, "links": { "GetAaaRetentionPolicyByMoid": { "operationId": "GetAaaRetentionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/aaa/RetentionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/apiproxy/AllowLists": { "get": { "tags": [ "apiproxy" ], "summary": "Read a 'apiproxy.AllowList' resource.", "operationId": "GetApiproxyAllowListList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.apiproxy.AllowList", "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 'apiproxy.AllowList' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiproxy.AllowList.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/apiproxy/AllowLists/{Moid}": { "get": { "tags": [ "apiproxy" ], "summary": "Read a 'apiproxy.AllowList' resource.", "operationId": "GetApiproxyAllowListByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.apiproxy.AllowList", "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 'apiproxy.AllowList' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apiproxy.AllowList" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApiproxyAllowListByMoid": { "operationId": "GetApiproxyAllowListByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/apiproxy/AllowLists/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/AppOpStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.AppOpStatus' resource.", "operationId": "GetApplianceAppOpStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.AppOpStatus", "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 'appliance.AppOpStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.AppOpStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/AppOpStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.AppOpStatus' resource.", "operationId": "GetApplianceAppOpStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.AppOpStatus", "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 'appliance.AppOpStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.AppOpStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceAppOpStatusByMoid": { "operationId": "GetApplianceAppOpStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/AppOpStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/AppStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.AppStatus' resource.", "operationId": "GetApplianceAppStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.AppStatus", "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 'appliance.AppStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.AppStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/AppStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.AppStatus' resource.", "operationId": "GetApplianceAppStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.AppStatus", "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 'appliance.AppStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.AppStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceAppStatusByMoid": { "operationId": "GetApplianceAppStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/AppStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/AutoRmaPolicies": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.AutoRmaPolicy' resource.", "operationId": "GetApplianceAutoRmaPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.appliance.AutoRmaPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.AutoRmaPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.AutoRmaPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/AutoRmaPolicies/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.AutoRmaPolicy' resource.", "operationId": "GetApplianceAutoRmaPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.appliance.AutoRmaPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.AutoRmaPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.AutoRmaPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceAutoRmaPolicyByMoid": { "operationId": "GetApplianceAutoRmaPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/AutoRmaPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/Backups": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.Backup' resource.", "operationId": "GetApplianceBackupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.Backup", "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 'appliance.Backup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.Backup.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Create a 'appliance.Backup' resource.", "operationId": "CreateApplianceBackup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.Backup", "PRIVSET.Account Administrator", "PRIVSET.Create backups", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.Backup' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.Backup" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.Backup' resource was created as requested. The 'appliance.Backup' 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/appliance.Backup" } } }, "links": { "GetApplianceBackupByMoid": { "operationId": "GetApplianceBackupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/Backups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/Backups/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.Backup' resource.", "operationId": "GetApplianceBackupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.Backup", "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 'appliance.Backup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.Backup" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceBackupByMoid": { "operationId": "GetApplianceBackupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/Backups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Delete a 'appliance.Backup' resource.", "operationId": "DeleteApplianceBackup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.appliance.Backup", "PRIVSET.Account Administrator", "PRIVSET.Create backups", "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/appliance/BackupDownloads": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.BackupDownload' resource.", "operationId": "GetApplianceBackupDownloadList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.BackupDownload", "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 'appliance.BackupDownload' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupDownload.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/BackupDownloads/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.BackupDownload' resource.", "operationId": "GetApplianceBackupDownloadByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.BackupDownload", "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 'appliance.BackupDownload' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupDownload" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceBackupDownloadByMoid": { "operationId": "GetApplianceBackupDownloadByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/BackupDownloads/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/BackupMonitors": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.BackupMonitor' resource.", "operationId": "GetApplianceBackupMonitorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.BackupMonitor" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.BackupMonitor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupMonitor.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/BackupMonitors/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.BackupMonitor' resource.", "operationId": "GetApplianceBackupMonitorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.BackupMonitor" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.BackupMonitor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupMonitor" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceBackupMonitorByMoid": { "operationId": "GetApplianceBackupMonitorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/BackupMonitors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/BackupPolicies": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.BackupPolicy' resource.", "operationId": "GetApplianceBackupPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.BackupPolicy", "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 'appliance.BackupPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Create a 'appliance.BackupPolicy' resource.", "operationId": "CreateApplianceBackupPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.BackupPolicy", "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.BackupPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.BackupPolicy' resource was created as requested. The 'appliance.BackupPolicy' 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/appliance.BackupPolicy" } } }, "links": { "GetApplianceBackupPolicyByMoid": { "operationId": "GetApplianceBackupPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/BackupPolicies/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.BackupPolicy' resource.", "operationId": "GetApplianceBackupPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.BackupPolicy", "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 'appliance.BackupPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceBackupPolicyByMoid": { "operationId": "GetApplianceBackupPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Update a 'appliance.BackupPolicy' resource.", "operationId": "UpdateApplianceBackupPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "ROLE.Account Administrator", "UPDATE.appliance.BackupPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.BackupPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.BackupPolicy' resource was modified as requested. The 'appliance.BackupPolicy' 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/appliance.BackupPolicy" } } }, "links": { "GetApplianceBackupPolicyByMoid": { "operationId": "GetApplianceBackupPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Update a 'appliance.BackupPolicy' resource.", "operationId": "PatchApplianceBackupPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "ROLE.Account Administrator", "UPDATE.appliance.BackupPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.BackupPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.BackupPolicy' resource was patched as requested. The 'appliance.BackupPolicy' 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/appliance.BackupPolicy" } } }, "links": { "GetApplianceBackupPolicyByMoid": { "operationId": "GetApplianceBackupPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/BackupPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/BackupRotateData": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.BackupRotateData' resource.", "operationId": "GetApplianceBackupRotateDataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.BackupRotateData", "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 'appliance.BackupRotateData' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupRotateData.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/BackupRotateData/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.BackupRotateData' resource.", "operationId": "GetApplianceBackupRotateDataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.BackupRotateData", "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 'appliance.BackupRotateData' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.BackupRotateData" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceBackupRotateDataByMoid": { "operationId": "GetApplianceBackupRotateDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/BackupRotateData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/CertificateSettings": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.CertificateSetting' resource.", "operationId": "GetApplianceCertificateSettingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.CertificateSetting", "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 'appliance.CertificateSetting' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.CertificateSetting.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/CertificateSettings/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.CertificateSetting' resource.", "operationId": "GetApplianceCertificateSettingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.CertificateSetting", "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 'appliance.CertificateSetting' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.CertificateSetting" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceCertificateSettingByMoid": { "operationId": "GetApplianceCertificateSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/CertificateSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.CertificateSetting' resource.", "operationId": "UpdateApplianceCertificateSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.CertificateSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.CertificateSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.CertificateSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.CertificateSetting' resource was modified as requested. The 'appliance.CertificateSetting' 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/appliance.CertificateSetting" } } }, "links": { "GetApplianceCertificateSettingByMoid": { "operationId": "GetApplianceCertificateSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/CertificateSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.CertificateSetting' resource.", "operationId": "PatchApplianceCertificateSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.CertificateSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.CertificateSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.CertificateSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.CertificateSetting' resource was patched as requested. The 'appliance.CertificateSetting' 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/appliance.CertificateSetting" } } }, "links": { "GetApplianceCertificateSettingByMoid": { "operationId": "GetApplianceCertificateSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/CertificateSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterInfos": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ClusterInfo' resource.", "operationId": "GetApplianceClusterInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.ClusterInfo", "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 'appliance.ClusterInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.ClusterInfo' resource.", "operationId": "CreateApplianceClusterInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.ClusterInfo", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.ClusterInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterInfo' resource was created as requested. The 'appliance.ClusterInfo' 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/appliance.ClusterInfo" } } }, "links": { "GetApplianceClusterInfoByMoid": { "operationId": "GetApplianceClusterInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterInfos/{Moid}": { "post": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ClusterInfo' resource.", "operationId": "UpdateApplianceClusterInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.ClusterInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ClusterInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInfo" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterInfo' resource was modified as requested. The 'appliance.ClusterInfo' 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/appliance.ClusterInfo" } } }, "links": { "GetApplianceClusterInfoByMoid": { "operationId": "GetApplianceClusterInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ClusterInfo' resource.", "operationId": "PatchApplianceClusterInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.ClusterInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ClusterInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInfo" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterInfo' resource was patched as requested. The 'appliance.ClusterInfo' 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/appliance.ClusterInfo" } } }, "links": { "GetApplianceClusterInfoByMoid": { "operationId": "GetApplianceClusterInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Delete a 'appliance.ClusterInfo' resource.", "operationId": "DeleteApplianceClusterInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.appliance.ClusterInfo", "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" } } }, "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ClusterInfo' resource.", "operationId": "GetApplianceClusterInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.ClusterInfo", "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 'appliance.ClusterInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceClusterInfoByMoid": { "operationId": "GetApplianceClusterInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterInstalls": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ClusterInstall' resource.", "operationId": "GetApplianceClusterInstallList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.ClusterInstall" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.ClusterInstall' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInstall.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterInstalls/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ClusterInstall' resource.", "operationId": "GetApplianceClusterInstallByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.ClusterInstall" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.ClusterInstall' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInstall" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceClusterInstallByMoid": { "operationId": "GetApplianceClusterInstallByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterInstalls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ClusterInstall' resource.", "operationId": "UpdateApplianceClusterInstall", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.appliance.ClusterInstall" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ClusterInstall' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInstall" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterInstall' resource was modified as requested. The 'appliance.ClusterInstall' 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/appliance.ClusterInstall" } } }, "links": { "GetApplianceClusterInstallByMoid": { "operationId": "GetApplianceClusterInstallByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterInstalls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ClusterInstall' resource.", "operationId": "PatchApplianceClusterInstall", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.appliance.ClusterInstall" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ClusterInstall' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterInstall" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterInstall' resource was patched as requested. The 'appliance.ClusterInstall' 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/appliance.ClusterInstall" } } }, "links": { "GetApplianceClusterInstallByMoid": { "operationId": "GetApplianceClusterInstallByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterInstalls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterReplaceNodes": { "post": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.ClusterReplaceNode' resource.", "operationId": "CreateApplianceClusterReplaceNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.ClusterReplaceNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.ClusterReplaceNode' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterReplaceNode" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterReplaceNode' resource was created as requested. The 'appliance.ClusterReplaceNode' 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/appliance.ClusterReplaceNode" } } }, "links": { "GetApplianceClusterReplaceNodeByMoid": { "operationId": "GetApplianceClusterReplaceNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterReplaceNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ClusterReplaceNode' resource.", "operationId": "GetApplianceClusterReplaceNodeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.ClusterReplaceNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.ClusterReplaceNode' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterReplaceNode.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterReplaceNodes/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ClusterReplaceNode' resource.", "operationId": "GetApplianceClusterReplaceNodeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.ClusterReplaceNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.ClusterReplaceNode' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterReplaceNode" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceClusterReplaceNodeByMoid": { "operationId": "GetApplianceClusterReplaceNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterReplaceNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ClusterReplaceNode' resource.", "operationId": "UpdateApplianceClusterReplaceNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.appliance.ClusterReplaceNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ClusterReplaceNode' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterReplaceNode" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterReplaceNode' resource was modified as requested. The 'appliance.ClusterReplaceNode' 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/appliance.ClusterReplaceNode" } } }, "links": { "GetApplianceClusterReplaceNodeByMoid": { "operationId": "GetApplianceClusterReplaceNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterReplaceNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ClusterReplaceNode' resource.", "operationId": "PatchApplianceClusterReplaceNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.appliance.ClusterReplaceNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ClusterReplaceNode' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterReplaceNode" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterReplaceNode' resource was patched as requested. The 'appliance.ClusterReplaceNode' 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/appliance.ClusterReplaceNode" } } }, "links": { "GetApplianceClusterReplaceNodeByMoid": { "operationId": "GetApplianceClusterReplaceNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterReplaceNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterWorkerNodes": { "post": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.ClusterWorkerNode' resource.", "operationId": "CreateApplianceClusterWorkerNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.ClusterWorkerNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.ClusterWorkerNode' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterWorkerNode" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterWorkerNode' resource was created as requested. The 'appliance.ClusterWorkerNode' 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/appliance.ClusterWorkerNode" } } }, "links": { "GetApplianceClusterWorkerNodeByMoid": { "operationId": "GetApplianceClusterWorkerNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterWorkerNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ClusterWorkerNode' resource.", "operationId": "GetApplianceClusterWorkerNodeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.ClusterWorkerNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.ClusterWorkerNode' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterWorkerNode.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterWorkerNodes/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ClusterWorkerNode' resource.", "operationId": "GetApplianceClusterWorkerNodeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.ClusterWorkerNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.ClusterWorkerNode' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterWorkerNode" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceClusterWorkerNodeByMoid": { "operationId": "GetApplianceClusterWorkerNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterWorkerNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ClusterWorkerNode' resource.", "operationId": "UpdateApplianceClusterWorkerNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.appliance.ClusterWorkerNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ClusterWorkerNode' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterWorkerNode" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterWorkerNode' resource was modified as requested. The 'appliance.ClusterWorkerNode' 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/appliance.ClusterWorkerNode" } } }, "links": { "GetApplianceClusterWorkerNodeByMoid": { "operationId": "GetApplianceClusterWorkerNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterWorkerNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ClusterWorkerNode' resource.", "operationId": "PatchApplianceClusterWorkerNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.appliance.ClusterWorkerNode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ClusterWorkerNode' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterWorkerNode" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterWorkerNode' resource was patched as requested. The 'appliance.ClusterWorkerNode' 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/appliance.ClusterWorkerNode" } } }, "links": { "GetApplianceClusterWorkerNodeByMoid": { "operationId": "GetApplianceClusterWorkerNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterWorkerNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterWorkerNodeReplaces": { "post": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.ClusterWorkerNodeReplace' resource.", "operationId": "CreateApplianceClusterWorkerNodeReplace", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.ClusterWorkerNodeReplace" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.ClusterWorkerNodeReplace' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterWorkerNodeReplace" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterWorkerNodeReplace' resource was created as requested. The 'appliance.ClusterWorkerNodeReplace' 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/appliance.ClusterWorkerNodeReplace" } } }, "links": { "GetApplianceClusterWorkerNodeReplaceByMoid": { "operationId": "GetApplianceClusterWorkerNodeReplaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterWorkerNodeReplaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ClusterWorkerNodeReuses": { "post": { "tags": [ "appliance" ], "summary": "Create a 'appliance.ClusterWorkerNodeReuse' resource.", "operationId": "CreateApplianceClusterWorkerNodeReuse", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.ClusterWorkerNodeReuse" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.ClusterWorkerNodeReuse' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ClusterWorkerNodeReuse" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ClusterWorkerNodeReuse' resource was created as requested. The 'appliance.ClusterWorkerNodeReuse' 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/appliance.ClusterWorkerNodeReuse" } } }, "links": { "GetApplianceClusterWorkerNodeReuseByMoid": { "operationId": "GetApplianceClusterWorkerNodeReuseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ClusterWorkerNodeReuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/CpuUtilizations": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.CpuUtilization' resource.", "operationId": "GetApplianceCpuUtilizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.CpuUtilization", "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 'appliance.CpuUtilization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.CpuUtilization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/CpuUtilizations/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.CpuUtilization' resource.", "operationId": "GetApplianceCpuUtilizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.CpuUtilization", "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 'appliance.CpuUtilization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.CpuUtilization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceCpuUtilizationByMoid": { "operationId": "GetApplianceCpuUtilizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/CpuUtilizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DataExportPolicies": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.DataExportPolicy' resource.", "operationId": "GetApplianceDataExportPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure data collection settings", "PRIVSET.Read-Only", "READ.appliance.DataExportPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.DataExportPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DataExportPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Create a 'appliance.DataExportPolicy' resource.", "operationId": "CreateApplianceDataExportPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.DataExportPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.DataExportPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DataExportPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DataExportPolicy' resource was created as requested. The 'appliance.DataExportPolicy' 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/appliance.DataExportPolicy" } } }, "links": { "GetApplianceDataExportPolicyByMoid": { "operationId": "GetApplianceDataExportPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DataExportPolicies/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.DataExportPolicy' resource.", "operationId": "GetApplianceDataExportPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure data collection settings", "PRIVSET.Read-Only", "READ.appliance.DataExportPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.DataExportPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DataExportPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceDataExportPolicyByMoid": { "operationId": "GetApplianceDataExportPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Update a 'appliance.DataExportPolicy' resource.", "operationId": "UpdateApplianceDataExportPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure data collection settings", "ROLE.Account Administrator", "UPDATE.appliance.DataExportPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.DataExportPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DataExportPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DataExportPolicy' resource was modified as requested. The 'appliance.DataExportPolicy' 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/appliance.DataExportPolicy" } } }, "links": { "GetApplianceDataExportPolicyByMoid": { "operationId": "GetApplianceDataExportPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Update a 'appliance.DataExportPolicy' resource.", "operationId": "PatchApplianceDataExportPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure data collection settings", "ROLE.Account Administrator", "UPDATE.appliance.DataExportPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.DataExportPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DataExportPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DataExportPolicy' resource was patched as requested. The 'appliance.DataExportPolicy' 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/appliance.DataExportPolicy" } } }, "links": { "GetApplianceDataExportPolicyByMoid": { "operationId": "GetApplianceDataExportPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DataExportPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceCertificates": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.DeviceCertificate' resource.", "operationId": "GetApplianceDeviceCertificateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.DeviceCertificate" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.DeviceCertificate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceCertificate.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceCertificates/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.DeviceCertificate' resource.", "operationId": "GetApplianceDeviceCertificateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.DeviceCertificate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.DeviceCertificate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceCertificate" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceDeviceCertificateByMoid": { "operationId": "GetApplianceDeviceCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceCertificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceClaims": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.DeviceClaim' resource.", "operationId": "GetApplianceDeviceClaimList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "PRIVSET.Read-Only", "PRIVSET.Unclaim targets", "READ.appliance.DeviceClaim", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.DeviceClaim' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceClaim.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.DeviceClaim' resource.", "operationId": "CreateApplianceDeviceClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.DeviceClaim", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.DeviceClaim' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceClaim" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DeviceClaim' resource was created as requested. The 'appliance.DeviceClaim' 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/appliance.DeviceClaim" } } }, "links": { "GetApplianceDeviceClaimByMoid": { "operationId": "GetApplianceDeviceClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceClaims/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.DeviceClaim' resource.", "operationId": "GetApplianceDeviceClaimByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "PRIVSET.Read-Only", "PRIVSET.Unclaim targets", "READ.appliance.DeviceClaim", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.DeviceClaim' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceClaim" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceDeviceClaimByMoid": { "operationId": "GetApplianceDeviceClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.DeviceClaim' resource.", "operationId": "UpdateApplianceDeviceClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Unclaim targets", "ROLE.Account Administrator", "UPDATE.appliance.DeviceClaim" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.DeviceClaim' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceClaim" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DeviceClaim' resource was modified as requested. The 'appliance.DeviceClaim' 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/appliance.DeviceClaim" } } }, "links": { "GetApplianceDeviceClaimByMoid": { "operationId": "GetApplianceDeviceClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.DeviceClaim' resource.", "operationId": "PatchApplianceDeviceClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Unclaim targets", "ROLE.Account Administrator", "UPDATE.appliance.DeviceClaim" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.DeviceClaim' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceClaim" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DeviceClaim' resource was patched as requested. The 'appliance.DeviceClaim' 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/appliance.DeviceClaim" } } }, "links": { "GetApplianceDeviceClaimByMoid": { "operationId": "GetApplianceDeviceClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceClusterInstalls": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.DeviceClusterInstall' resource.", "operationId": "GetApplianceDeviceClusterInstallList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.DeviceClusterInstall" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.DeviceClusterInstall' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceClusterInstall.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceClusterInstalls/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.DeviceClusterInstall' resource.", "operationId": "GetApplianceDeviceClusterInstallByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.DeviceClusterInstall" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.DeviceClusterInstall' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceClusterInstall" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceDeviceClusterInstallByMoid": { "operationId": "GetApplianceDeviceClusterInstallByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceClusterInstalls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceStates": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.DeviceState' resource.", "operationId": "GetApplianceDeviceStateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.DeviceState", "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 'appliance.DeviceState' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceState.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceStates/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.DeviceState' resource.", "operationId": "GetApplianceDeviceStateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.DeviceState", "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 'appliance.DeviceState' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceState" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceDeviceStateByMoid": { "operationId": "GetApplianceDeviceStateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceStates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceUpgradePolicies": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.DeviceUpgradePolicy' resource.", "operationId": "GetApplianceDeviceUpgradePolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.DeviceUpgradePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.DeviceUpgradePolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceUpgradePolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DeviceUpgradePolicies/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.DeviceUpgradePolicy' resource.", "operationId": "GetApplianceDeviceUpgradePolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.DeviceUpgradePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.DeviceUpgradePolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceUpgradePolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceDeviceUpgradePolicyByMoid": { "operationId": "GetApplianceDeviceUpgradePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceUpgradePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Update a 'appliance.DeviceUpgradePolicy' resource.", "operationId": "UpdateApplianceDeviceUpgradePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.DeviceUpgradePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.DeviceUpgradePolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceUpgradePolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DeviceUpgradePolicy' resource was modified as requested. The 'appliance.DeviceUpgradePolicy' 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/appliance.DeviceUpgradePolicy" } } }, "links": { "GetApplianceDeviceUpgradePolicyByMoid": { "operationId": "GetApplianceDeviceUpgradePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceUpgradePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Update a 'appliance.DeviceUpgradePolicy' resource.", "operationId": "PatchApplianceDeviceUpgradePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.DeviceUpgradePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.DeviceUpgradePolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DeviceUpgradePolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DeviceUpgradePolicy' resource was patched as requested. The 'appliance.DeviceUpgradePolicy' 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/appliance.DeviceUpgradePolicy" } } }, "links": { "GetApplianceDeviceUpgradePolicyByMoid": { "operationId": "GetApplianceDeviceUpgradePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DeviceUpgradePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DiagSettings": { "post": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.DiagSetting' resource.", "operationId": "CreateApplianceDiagSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.DiagSetting", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.DiagSetting' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DiagSetting" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DiagSetting' resource was created as requested. The 'appliance.DiagSetting' 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/appliance.DiagSetting" } } }, "links": { "GetApplianceDiagSettingByMoid": { "operationId": "GetApplianceDiagSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.DiagSetting' resource.", "operationId": "GetApplianceDiagSettingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.DiagSetting", "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 'appliance.DiagSetting' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DiagSetting.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/DiagSettings/{Moid}": { "post": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.DiagSetting' resource.", "operationId": "UpdateApplianceDiagSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.DiagSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.DiagSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DiagSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DiagSetting' resource was modified as requested. The 'appliance.DiagSetting' 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/appliance.DiagSetting" } } }, "links": { "GetApplianceDiagSettingByMoid": { "operationId": "GetApplianceDiagSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.DiagSetting' resource.", "operationId": "PatchApplianceDiagSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.DiagSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.DiagSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DiagSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.DiagSetting' resource was patched as requested. The 'appliance.DiagSetting' 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/appliance.DiagSetting" } } }, "links": { "GetApplianceDiagSettingByMoid": { "operationId": "GetApplianceDiagSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.DiagSetting' resource.", "operationId": "GetApplianceDiagSettingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.DiagSetting", "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 'appliance.DiagSetting' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.DiagSetting" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceDiagSettingByMoid": { "operationId": "GetApplianceDiagSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/DiagSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ExternalSyslogSettings": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ExternalSyslogSetting' resource.", "operationId": "GetApplianceExternalSyslogSettingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add external syslog servers", "PRIVSET.Delete external syslog servers", "PRIVSET.Edit external syslog servers", "PRIVSET.External Syslog Administrator", "READ.appliance.ExternalSyslogSetting", "ROLE.Account Administrator", "ROLE.External Syslog 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 'appliance.ExternalSyslogSetting' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ExternalSyslogSetting.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.ExternalSyslogSetting' resource.", "operationId": "CreateApplianceExternalSyslogSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.ExternalSyslogSetting", "PRIVSET.Account Administrator", "PRIVSET.Add external syslog servers", "PRIVSET.External Syslog Administrator", "ROLE.Account Administrator", "ROLE.External Syslog Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.ExternalSyslogSetting' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ExternalSyslogSetting" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ExternalSyslogSetting' resource was created as requested. The 'appliance.ExternalSyslogSetting' 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/appliance.ExternalSyslogSetting" } } }, "links": { "GetApplianceExternalSyslogSettingByMoid": { "operationId": "GetApplianceExternalSyslogSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ExternalSyslogSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ExternalSyslogSettings/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ExternalSyslogSetting' resource.", "operationId": "GetApplianceExternalSyslogSettingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add external syslog servers", "PRIVSET.Delete external syslog servers", "PRIVSET.Edit external syslog servers", "PRIVSET.External Syslog Administrator", "READ.appliance.ExternalSyslogSetting", "ROLE.Account Administrator", "ROLE.External Syslog 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 'appliance.ExternalSyslogSetting' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ExternalSyslogSetting" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceExternalSyslogSettingByMoid": { "operationId": "GetApplianceExternalSyslogSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ExternalSyslogSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ExternalSyslogSetting' resource.", "operationId": "UpdateApplianceExternalSyslogSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit external syslog servers", "PRIVSET.External Syslog Administrator", "ROLE.Account Administrator", "ROLE.External Syslog Administrator", "UPDATE.appliance.ExternalSyslogSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ExternalSyslogSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ExternalSyslogSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ExternalSyslogSetting' resource was modified as requested. The 'appliance.ExternalSyslogSetting' 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/appliance.ExternalSyslogSetting" } } }, "links": { "GetApplianceExternalSyslogSettingByMoid": { "operationId": "GetApplianceExternalSyslogSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ExternalSyslogSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.ExternalSyslogSetting' resource.", "operationId": "PatchApplianceExternalSyslogSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit external syslog servers", "PRIVSET.External Syslog Administrator", "ROLE.Account Administrator", "ROLE.External Syslog Administrator", "UPDATE.appliance.ExternalSyslogSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.ExternalSyslogSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ExternalSyslogSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.ExternalSyslogSetting' resource was patched as requested. The 'appliance.ExternalSyslogSetting' 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/appliance.ExternalSyslogSetting" } } }, "links": { "GetApplianceExternalSyslogSettingByMoid": { "operationId": "GetApplianceExternalSyslogSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ExternalSyslogSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Delete a 'appliance.ExternalSyslogSetting' resource.", "operationId": "DeleteApplianceExternalSyslogSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.appliance.ExternalSyslogSetting", "PRIVSET.Account Administrator", "PRIVSET.Delete external syslog servers", "PRIVSET.External Syslog Administrator", "ROLE.Account Administrator", "ROLE.External Syslog 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/appliance/FileGateways": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.FileGateway' resource.", "operationId": "GetApplianceFileGatewayList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.FileGateway" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.FileGateway' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileGateway.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileGateways/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.FileGateway' resource.", "operationId": "GetApplianceFileGatewayByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.FileGateway" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.FileGateway' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileGateway" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceFileGatewayByMoid": { "operationId": "GetApplianceFileGatewayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FileGateways/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileSystemOpStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.FileSystemOpStatus' resource.", "operationId": "GetApplianceFileSystemOpStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.FileSystemOpStatus", "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 'appliance.FileSystemOpStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileSystemOpStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileSystemOpStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.FileSystemOpStatus' resource.", "operationId": "GetApplianceFileSystemOpStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.FileSystemOpStatus", "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 'appliance.FileSystemOpStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileSystemOpStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceFileSystemOpStatusByMoid": { "operationId": "GetApplianceFileSystemOpStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FileSystemOpStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileSystemOpSummaries": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.FileSystemOpSummary' resource.", "operationId": "GetApplianceFileSystemOpSummaryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.FileSystemOpSummary", "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 'appliance.FileSystemOpSummary' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileSystemOpSummary.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileSystemOpSummaries/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.FileSystemOpSummary' resource.", "operationId": "GetApplianceFileSystemOpSummaryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.FileSystemOpSummary", "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 'appliance.FileSystemOpSummary' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileSystemOpSummary" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceFileSystemOpSummaryByMoid": { "operationId": "GetApplianceFileSystemOpSummaryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FileSystemOpSummaries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileSystemStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.FileSystemStatus' resource.", "operationId": "GetApplianceFileSystemStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.FileSystemStatus", "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 'appliance.FileSystemStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileSystemStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileSystemStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.FileSystemStatus' resource.", "operationId": "GetApplianceFileSystemStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.FileSystemStatus", "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 'appliance.FileSystemStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileSystemStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceFileSystemStatusByMoid": { "operationId": "GetApplianceFileSystemStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FileSystemStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileSystemTelemetries": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.FileSystemTelemetry' resource.", "operationId": "GetApplianceFileSystemTelemetryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.FileSystemTelemetry", "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 'appliance.FileSystemTelemetry' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileSystemTelemetry.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FileSystemTelemetries/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.FileSystemTelemetry' resource.", "operationId": "GetApplianceFileSystemTelemetryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.FileSystemTelemetry", "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 'appliance.FileSystemTelemetry' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FileSystemTelemetry" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceFileSystemTelemetryByMoid": { "operationId": "GetApplianceFileSystemTelemetryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FileSystemTelemetries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FqdnUpdates": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.FqdnUpdate' resource.", "operationId": "GetApplianceFqdnUpdateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.View Devices", "READ.appliance.FqdnUpdate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.FqdnUpdate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FqdnUpdate.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.FqdnUpdate' resource.", "operationId": "CreateApplianceFqdnUpdate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.FqdnUpdate", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.FqdnUpdate' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FqdnUpdate" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.FqdnUpdate' resource was created as requested. The 'appliance.FqdnUpdate' 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/appliance.FqdnUpdate" } } }, "links": { "GetApplianceFqdnUpdateByMoid": { "operationId": "GetApplianceFqdnUpdateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FqdnUpdates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/FqdnUpdates/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.FqdnUpdate' resource.", "operationId": "GetApplianceFqdnUpdateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.View Devices", "READ.appliance.FqdnUpdate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.FqdnUpdate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FqdnUpdate" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceFqdnUpdateByMoid": { "operationId": "GetApplianceFqdnUpdateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FqdnUpdates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.FqdnUpdate' resource.", "operationId": "UpdateApplianceFqdnUpdate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.FqdnUpdate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.FqdnUpdate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FqdnUpdate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.FqdnUpdate' resource was modified as requested. The 'appliance.FqdnUpdate' 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/appliance.FqdnUpdate" } } }, "links": { "GetApplianceFqdnUpdateByMoid": { "operationId": "GetApplianceFqdnUpdateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FqdnUpdates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.FqdnUpdate' resource.", "operationId": "PatchApplianceFqdnUpdate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.FqdnUpdate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.FqdnUpdate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.FqdnUpdate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.FqdnUpdate' resource was patched as requested. The 'appliance.FqdnUpdate' 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/appliance.FqdnUpdate" } } }, "links": { "GetApplianceFqdnUpdateByMoid": { "operationId": "GetApplianceFqdnUpdateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/FqdnUpdates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/GroupOpStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.GroupOpStatus' resource.", "operationId": "GetApplianceGroupOpStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.GroupOpStatus", "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 'appliance.GroupOpStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.GroupOpStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/GroupOpStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.GroupOpStatus' resource.", "operationId": "GetApplianceGroupOpStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.GroupOpStatus", "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 'appliance.GroupOpStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.GroupOpStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceGroupOpStatusByMoid": { "operationId": "GetApplianceGroupOpStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/GroupOpStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/GroupStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.GroupStatus' resource.", "operationId": "GetApplianceGroupStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.GroupStatus", "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 'appliance.GroupStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.GroupStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/GroupStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.GroupStatus' resource.", "operationId": "GetApplianceGroupStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.GroupStatus", "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 'appliance.GroupStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.GroupStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceGroupStatusByMoid": { "operationId": "GetApplianceGroupStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/GroupStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ImageBundles": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ImageBundle' resource.", "operationId": "GetApplianceImageBundleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure software update settings", "PRIVSET.Install updates", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "READ.appliance.ImageBundle", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.ImageBundle' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ImageBundle.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ImageBundles/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ImageBundle' resource.", "operationId": "GetApplianceImageBundleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure software update settings", "PRIVSET.Install updates", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "READ.appliance.ImageBundle", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.ImageBundle' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ImageBundle" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceImageBundleByMoid": { "operationId": "GetApplianceImageBundleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ImageBundles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/MemoryUtilizations": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.MemoryUtilization' resource.", "operationId": "GetApplianceMemoryUtilizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.MemoryUtilization", "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 'appliance.MemoryUtilization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MemoryUtilization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/MemoryUtilizations/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.MemoryUtilization' resource.", "operationId": "GetApplianceMemoryUtilizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.MemoryUtilization", "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 'appliance.MemoryUtilization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MemoryUtilization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceMemoryUtilizationByMoid": { "operationId": "GetApplianceMemoryUtilizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/MemoryUtilizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/MetaManifests": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.MetaManifest' resource.", "operationId": "GetApplianceMetaManifestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "READ.appliance.MetaManifest", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.MetaManifest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MetaManifest.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/MetaManifests/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.MetaManifest' resource.", "operationId": "GetApplianceMetaManifestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "READ.appliance.MetaManifest", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.MetaManifest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MetaManifest" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceMetaManifestByMoid": { "operationId": "GetApplianceMetaManifestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/MetaManifests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/MetricsConfigs": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.MetricsConfig' resource.", "operationId": "GetApplianceMetricsConfigList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only metrics explorations", "PRIVSET.Server Administrator", "READ.appliance.MetricsConfig", "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 'appliance.MetricsConfig' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MetricsConfig.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/MetricsConfigs/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.MetricsConfig' resource.", "operationId": "GetApplianceMetricsConfigByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only metrics explorations", "PRIVSET.Server Administrator", "READ.appliance.MetricsConfig", "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 'appliance.MetricsConfig' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MetricsConfig" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceMetricsConfigByMoid": { "operationId": "GetApplianceMetricsConfigByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/MetricsConfigs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.MetricsConfig' resource.", "operationId": "UpdateApplianceMetricsConfig", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.MetricsConfig" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.MetricsConfig' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MetricsConfig" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.MetricsConfig' resource was modified as requested. The 'appliance.MetricsConfig' 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/appliance.MetricsConfig" } } }, "links": { "GetApplianceMetricsConfigByMoid": { "operationId": "GetApplianceMetricsConfigByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/MetricsConfigs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.MetricsConfig' resource.", "operationId": "PatchApplianceMetricsConfig", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.MetricsConfig" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.MetricsConfig' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MetricsConfig" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.MetricsConfig' resource was patched as requested. The 'appliance.MetricsConfig' 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/appliance.MetricsConfig" } } }, "links": { "GetApplianceMetricsConfigByMoid": { "operationId": "GetApplianceMetricsConfigByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/MetricsConfigs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/MetricsIngestionUtilizations": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.MetricsIngestionUtilization' resource.", "operationId": "GetApplianceMetricsIngestionUtilizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "READ.appliance.MetricsIngestionUtilization", "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 'appliance.MetricsIngestionUtilization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MetricsIngestionUtilization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/MetricsIngestionUtilizations/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.MetricsIngestionUtilization' resource.", "operationId": "GetApplianceMetricsIngestionUtilizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "READ.appliance.MetricsIngestionUtilization", "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 'appliance.MetricsIngestionUtilization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.MetricsIngestionUtilization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceMetricsIngestionUtilizationByMoid": { "operationId": "GetApplianceMetricsIngestionUtilizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/MetricsIngestionUtilizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NetworkLinkStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.NetworkLinkStatus' resource.", "operationId": "GetApplianceNetworkLinkStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NetworkLinkStatus", "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 'appliance.NetworkLinkStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NetworkLinkStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NetworkLinkStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.NetworkLinkStatus' resource.", "operationId": "GetApplianceNetworkLinkStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NetworkLinkStatus", "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 'appliance.NetworkLinkStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NetworkLinkStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceNetworkLinkStatusByMoid": { "operationId": "GetApplianceNetworkLinkStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/NetworkLinkStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeInfos": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.NodeInfo' resource.", "operationId": "GetApplianceNodeInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Read-Only", "READ.appliance.NodeInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.NodeInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeInfos/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.NodeInfo' resource.", "operationId": "GetApplianceNodeInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Read-Only", "READ.appliance.NodeInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.NodeInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceNodeInfoByMoid": { "operationId": "GetApplianceNodeInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/NodeInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeIopsMetrics": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.NodeIopsMetric' resource.", "operationId": "GetApplianceNodeIopsMetricList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NodeIopsMetric", "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 'appliance.NodeIopsMetric' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeIopsMetric.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeIopsMetrics/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.NodeIopsMetric' resource.", "operationId": "GetApplianceNodeIopsMetricByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NodeIopsMetric", "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 'appliance.NodeIopsMetric' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeIopsMetric" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceNodeIopsMetricByMoid": { "operationId": "GetApplianceNodeIopsMetricByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/NodeIopsMetrics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeOpStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.NodeOpStatus' resource.", "operationId": "GetApplianceNodeOpStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NodeOpStatus", "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 'appliance.NodeOpStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeOpStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeOpStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.NodeOpStatus' resource.", "operationId": "GetApplianceNodeOpStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NodeOpStatus", "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 'appliance.NodeOpStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeOpStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceNodeOpStatusByMoid": { "operationId": "GetApplianceNodeOpStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/NodeOpStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.NodeStatus' resource.", "operationId": "GetApplianceNodeStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NodeStatus", "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 'appliance.NodeStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.NodeStatus' resource.", "operationId": "GetApplianceNodeStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NodeStatus", "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 'appliance.NodeStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceNodeStatusByMoid": { "operationId": "GetApplianceNodeStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/NodeStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeTelemetries": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.NodeTelemetry' resource.", "operationId": "GetApplianceNodeTelemetryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NodeTelemetry", "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 'appliance.NodeTelemetry' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeTelemetry.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/NodeTelemetries/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.NodeTelemetry' resource.", "operationId": "GetApplianceNodeTelemetryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.NodeTelemetry", "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 'appliance.NodeTelemetry' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.NodeTelemetry" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceNodeTelemetryByMoid": { "operationId": "GetApplianceNodeTelemetryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/NodeTelemetries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ReleaseNotes": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ReleaseNote' resource.", "operationId": "GetApplianceReleaseNoteList", "deprecated": true, "x-sunset": "2027-03-01", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.ReleaseNote" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.ReleaseNote' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ReleaseNote.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/ReleaseNotes/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.ReleaseNote' resource.", "operationId": "GetApplianceReleaseNoteByMoid", "deprecated": true, "x-sunset": "2027-03-01", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.appliance.ReleaseNote" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.ReleaseNote' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.ReleaseNote" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceReleaseNoteByMoid": { "operationId": "GetApplianceReleaseNoteByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/ReleaseNotes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/RemoteFileImports": { "post": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Create a 'appliance.RemoteFileImport' resource.", "operationId": "CreateApplianceRemoteFileImport", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.RemoteFileImport", "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster Administrator", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.RemoteFileImport' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.RemoteFileImport" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.RemoteFileImport' resource was created as requested. The 'appliance.RemoteFileImport' 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/appliance.RemoteFileImport" } } }, "links": { "GetApplianceRemoteFileImportByMoid": { "operationId": "GetApplianceRemoteFileImportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/RemoteFileImports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.RemoteFileImport' resource.", "operationId": "GetApplianceRemoteFileImportList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster Administrator", "PRIVSET.Server Administrator", "READ.appliance.RemoteFileImport", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster 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 'appliance.RemoteFileImport' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.RemoteFileImport.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/RemoteFileImports/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.RemoteFileImport' resource.", "operationId": "GetApplianceRemoteFileImportByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster Administrator", "PRIVSET.Server Administrator", "READ.appliance.RemoteFileImport", "ROLE.Account Administrator", "ROLE.HyperFlex Cluster 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 'appliance.RemoteFileImport' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.RemoteFileImport" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceRemoteFileImportByMoid": { "operationId": "GetApplianceRemoteFileImportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/RemoteFileImports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/Restores": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.Restore' resource.", "operationId": "GetApplianceRestoreList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.Restore", "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 'appliance.Restore' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.Restore.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Create a 'appliance.Restore' resource.", "operationId": "CreateApplianceRestore", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.appliance.Restore", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'appliance.Restore' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.Restore" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.Restore' resource was created as requested. The 'appliance.Restore' 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/appliance.Restore" } } }, "links": { "GetApplianceRestoreByMoid": { "operationId": "GetApplianceRestoreByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/Restores/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/Restores/{Moid}": { "get": { "tags": [ "appliance" ], "summary": "Read a 'appliance.Restore' resource.", "operationId": "GetApplianceRestoreByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure backup schedule", "PRIVSET.Create backups", "READ.appliance.Restore", "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 'appliance.Restore' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.Restore" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceRestoreByMoid": { "operationId": "GetApplianceRestoreByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/Restores/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "summary": "Delete a 'appliance.Restore' resource.", "operationId": "DeleteApplianceRestore", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.appliance.Restore", "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/appliance/SetupInfos": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.SetupInfo' resource.", "operationId": "GetApplianceSetupInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.appliance.SetupInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.SetupInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SetupInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/SetupInfos/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.SetupInfo' resource.", "operationId": "GetApplianceSetupInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.appliance.SetupInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.SetupInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SetupInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceSetupInfoByMoid": { "operationId": "GetApplianceSetupInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/SetupInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.SetupInfo' resource.", "operationId": "UpdateApplianceSetupInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.SetupInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.SetupInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SetupInfo" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.SetupInfo' resource was modified as requested. The 'appliance.SetupInfo' 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/appliance.SetupInfo" } } }, "links": { "GetApplianceSetupInfoByMoid": { "operationId": "GetApplianceSetupInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/SetupInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.SetupInfo' resource.", "operationId": "PatchApplianceSetupInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.appliance.SetupInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.SetupInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SetupInfo" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.SetupInfo' resource was patched as requested. The 'appliance.SetupInfo' 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/appliance.SetupInfo" } } }, "links": { "GetApplianceSetupInfoByMoid": { "operationId": "GetApplianceSetupInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/SetupInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/SystemInfos": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.SystemInfo' resource.", "operationId": "GetApplianceSystemInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Configure software update settings", "PRIVSET.Install updates", "PRIVSET.Read-Only", "READ.appliance.SystemInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'appliance.SystemInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SystemInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/SystemInfos/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.SystemInfo' resource.", "operationId": "GetApplianceSystemInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Configure software update settings", "PRIVSET.Install updates", "PRIVSET.Read-Only", "READ.appliance.SystemInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'appliance.SystemInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SystemInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceSystemInfoByMoid": { "operationId": "GetApplianceSystemInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/SystemInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/SystemOpStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.SystemOpStatus' resource.", "operationId": "GetApplianceSystemOpStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.SystemOpStatus", "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 'appliance.SystemOpStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SystemOpStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/SystemOpStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.SystemOpStatus' resource.", "operationId": "GetApplianceSystemOpStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.SystemOpStatus", "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 'appliance.SystemOpStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SystemOpStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceSystemOpStatusByMoid": { "operationId": "GetApplianceSystemOpStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/SystemOpStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/SystemStatuses": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.SystemStatus' resource.", "operationId": "GetApplianceSystemStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.SystemStatus", "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 'appliance.SystemStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SystemStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/SystemStatuses/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "SaaS", "summary": "Read a 'appliance.SystemStatus' resource.", "operationId": "GetApplianceSystemStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.SystemStatus", "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 'appliance.SystemStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.SystemStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceSystemStatusByMoid": { "operationId": "GetApplianceSystemStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/SystemStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/Upgrades": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.Upgrade' resource.", "operationId": "GetApplianceUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure software update settings", "PRIVSET.Install updates", "PRIVSET.Read-only all alarms", "READ.appliance.Upgrade", "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 'appliance.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/appliance.Upgrade.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/Upgrades/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.Upgrade' resource.", "operationId": "GetApplianceUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure software update settings", "PRIVSET.Install updates", "PRIVSET.Read-only all alarms", "READ.appliance.Upgrade", "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 'appliance.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/appliance.Upgrade" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceUpgradeByMoid": { "operationId": "GetApplianceUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/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" } } }, "post": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.Upgrade' resource.", "operationId": "UpdateApplianceUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.appliance.Upgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.Upgrade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.Upgrade" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.Upgrade' resource was modified as requested. The 'appliance.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/appliance.Upgrade" } } }, "links": { "GetApplianceUpgradeByMoid": { "operationId": "GetApplianceUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.Upgrade' resource.", "operationId": "PatchApplianceUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.appliance.Upgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.Upgrade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.Upgrade" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.Upgrade' resource was patched as requested. The 'appliance.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/appliance.Upgrade" } } }, "links": { "GetApplianceUpgradeByMoid": { "operationId": "GetApplianceUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Delete a 'appliance.Upgrade' resource.", "operationId": "DeleteApplianceUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.appliance.Upgrade", "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/appliance/UpgradePolicies": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.UpgradePolicy' resource.", "operationId": "GetApplianceUpgradePolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure software update settings", "PRIVSET.Install updates", "READ.appliance.UpgradePolicy", "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 'appliance.UpgradePolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.UpgradePolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/UpgradePolicies/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.UpgradePolicy' resource.", "operationId": "GetApplianceUpgradePolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure software update settings", "PRIVSET.Install updates", "READ.appliance.UpgradePolicy", "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 'appliance.UpgradePolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.UpgradePolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceUpgradePolicyByMoid": { "operationId": "GetApplianceUpgradePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/UpgradePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.UpgradePolicy' resource.", "operationId": "UpdateApplianceUpgradePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure software update settings", "ROLE.Account Administrator", "UPDATE.appliance.UpgradePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.UpgradePolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.UpgradePolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.UpgradePolicy' resource was modified as requested. The 'appliance.UpgradePolicy' 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/appliance.UpgradePolicy" } } }, "links": { "GetApplianceUpgradePolicyByMoid": { "operationId": "GetApplianceUpgradePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/UpgradePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Update a 'appliance.UpgradePolicy' resource.", "operationId": "PatchApplianceUpgradePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure software update settings", "ROLE.Account Administrator", "UPDATE.appliance.UpgradePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'appliance.UpgradePolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.UpgradePolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'appliance.UpgradePolicy' resource was patched as requested. The 'appliance.UpgradePolicy' 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/appliance.UpgradePolicy" } } }, "links": { "GetApplianceUpgradePolicyByMoid": { "operationId": "GetApplianceUpgradePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/UpgradePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/UpgradeTrackers": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.UpgradeTracker' resource.", "operationId": "GetApplianceUpgradeTrackerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.UpgradeTracker", "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 'appliance.UpgradeTracker' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.UpgradeTracker.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/appliance/UpgradeTrackers/{Moid}": { "get": { "tags": [ "appliance" ], "x-intersight-type": "Appliance", "summary": "Read a 'appliance.UpgradeTracker' resource.", "operationId": "GetApplianceUpgradeTrackerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.appliance.UpgradeTracker", "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 'appliance.UpgradeTracker' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appliance.UpgradeTracker" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetApplianceUpgradeTrackerByMoid": { "operationId": "GetApplianceUpgradeTrackerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/appliance/UpgradeTrackers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/ClaimTokens": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.ClaimToken' resource.", "operationId": "GetAssetClaimTokenList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "READ.asset.ClaimToken", "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 'asset.ClaimToken' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClaimToken.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Create a 'asset.ClaimToken' resource.", "operationId": "CreateAssetClaimToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.ClaimToken", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.ClaimToken' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClaimToken" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.ClaimToken' resource was created as requested. The 'asset.ClaimToken' 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/asset.ClaimToken" } } }, "links": { "GetAssetClaimTokenByMoid": { "operationId": "GetAssetClaimTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/ClaimTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/ClaimTokens/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.ClaimToken' resource.", "operationId": "GetAssetClaimTokenByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "READ.asset.ClaimToken", "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 'asset.ClaimToken' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClaimToken" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetClaimTokenByMoid": { "operationId": "GetAssetClaimTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/ClaimTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Delete a 'asset.ClaimToken' resource.", "operationId": "DeleteAssetClaimToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.asset.ClaimToken", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "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/asset/ClusterMembers": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.ClusterMember' resource.", "operationId": "GetAssetClusterMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS domain profiles", "PRIVSET.Read-only targets", "PRIVSET.View Devices", "READ.asset.ClusterMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.ClusterMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClusterMember.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/ClusterMembers/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.ClusterMember' resource.", "operationId": "GetAssetClusterMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS domain profiles", "PRIVSET.Read-only targets", "PRIVSET.View Devices", "READ.asset.ClusterMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.ClusterMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.ClusterMember" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetClusterMemberByMoid": { "operationId": "GetAssetClusterMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/ClusterMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Deployments": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Deployment' resource.", "operationId": "GetAssetDeploymentList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.Deployment", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.Deployment' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Deployment.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Deployments/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Deployment' resource.", "operationId": "GetAssetDeploymentByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.Deployment", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.Deployment' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Deployment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeploymentByMoid": { "operationId": "GetAssetDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeploymentDevices": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeploymentDevice' resource.", "operationId": "GetAssetDeploymentDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.DeploymentDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeploymentDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeploymentDevice.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeploymentDevices/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeploymentDevice' resource.", "operationId": "GetAssetDeploymentDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.DeploymentDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeploymentDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeploymentDevice" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeploymentDeviceByMoid": { "operationId": "GetAssetDeploymentDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeploymentDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceClaims": { "post": { "tags": [ "asset" ], "summary": "Create a 'asset.DeviceClaim' resource.", "operationId": "CreateAssetDeviceClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.DeviceClaim", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.DeviceClaim' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceClaim" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceClaim' resource was created as requested. The 'asset.DeviceClaim' 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/asset.DeviceClaim" } } }, "links": { "GetAssetDeviceClaimByMoid": { "operationId": "GetAssetDeviceClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceClaims/{Moid}": { "delete": { "tags": [ "asset" ], "summary": "Delete a 'asset.DeviceClaim' resource.", "operationId": "DeleteAssetDeviceClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.asset.DeviceClaim", "PRIVSET.Account Administrator", "PRIVSET.Delete Devices", "PRIVSET.Unclaim targets", "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/asset/DeviceConfigurations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceConfiguration' resource.", "operationId": "GetAssetDeviceConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.asset.DeviceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeviceConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceConfigurations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceConfiguration' resource.", "operationId": "GetAssetDeviceConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.asset.DeviceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeviceConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeviceConfigurationByMoid": { "operationId": "GetAssetDeviceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.DeviceConfiguration' resource.", "operationId": "UpdateAssetDeviceConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.asset.DeviceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceConfiguration' resource was modified as requested. The 'asset.DeviceConfiguration' 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/asset.DeviceConfiguration" } } }, "links": { "GetAssetDeviceConfigurationByMoid": { "operationId": "GetAssetDeviceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.DeviceConfiguration' resource.", "operationId": "PatchAssetDeviceConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.asset.DeviceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceConfiguration' resource was patched as requested. The 'asset.DeviceConfiguration' 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/asset.DeviceConfiguration" } } }, "links": { "GetAssetDeviceConfigurationByMoid": { "operationId": "GetAssetDeviceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceConnectorManagers": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceConnectorManager' resource.", "operationId": "GetAssetDeviceConnectorManagerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.View Devices", "READ.asset.DeviceConnectorManager", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeviceConnectorManager' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConnectorManager.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceConnectorManagers/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceConnectorManager' resource.", "operationId": "GetAssetDeviceConnectorManagerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.View Devices", "READ.asset.DeviceConnectorManager", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeviceConnectorManager' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceConnectorManager" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeviceConnectorManagerByMoid": { "operationId": "GetAssetDeviceConnectorManagerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceConnectorManagers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceContractInformations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceContractInformation' resource.", "operationId": "GetAssetDeviceContractInformationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.DeviceContractInformation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeviceContractInformation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceContractInformations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceContractInformation' resource.", "operationId": "GetAssetDeviceContractInformationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.DeviceContractInformation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeviceContractInformation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeviceContractInformationByMoid": { "operationId": "GetAssetDeviceContractInformationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.DeviceContractInformation' resource.", "operationId": "UpdateAssetDeviceContractInformation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.asset.DeviceContractInformation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceContractInformation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceContractInformation' resource was modified as requested. The 'asset.DeviceContractInformation' 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/asset.DeviceContractInformation" } } }, "links": { "GetAssetDeviceContractInformationByMoid": { "operationId": "GetAssetDeviceContractInformationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.DeviceContractInformation' resource.", "operationId": "PatchAssetDeviceContractInformation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.asset.DeviceContractInformation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceContractInformation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractInformation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceContractInformation' resource was patched as requested. The 'asset.DeviceContractInformation' 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/asset.DeviceContractInformation" } } }, "links": { "GetAssetDeviceContractInformationByMoid": { "operationId": "GetAssetDeviceContractInformationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractInformations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceContractNotifications": { "post": { "tags": [ "asset" ], "summary": "Create a 'asset.DeviceContractNotification' resource.", "operationId": "CreateAssetDeviceContractNotification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.DeviceContractNotification" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.DeviceContractNotification' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceContractNotification" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceContractNotification' resource was created as requested. The 'asset.DeviceContractNotification' 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/asset.DeviceContractNotification" } } }, "links": { "GetAssetDeviceContractNotificationByMoid": { "operationId": "GetAssetDeviceContractNotificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceContractNotifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceRegistrations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceRegistration' resource.", "operationId": "GetAssetDeviceRegistrationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only software repository", "PRIVSET.Read-only targets", "PRIVSET.Read-only tech support bundles", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.DeviceRegistration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.DeviceRegistration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/DeviceRegistrations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.DeviceRegistration' resource.", "operationId": "GetAssetDeviceRegistrationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only software repository", "PRIVSET.Read-only targets", "PRIVSET.Read-only tech support bundles", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.DeviceRegistration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.DeviceRegistration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetDeviceRegistrationByMoid": { "operationId": "GetAssetDeviceRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Updates the resource representing the device connector. For example, this can be used to annotate the device connector resource with user-specified tags.", "operationId": "UpdateAssetDeviceRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator", "UPDATE.asset.DeviceRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceRegistration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceRegistration' resource was modified as requested. The 'asset.DeviceRegistration' 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/asset.DeviceRegistration" } } }, "links": { "GetAssetDeviceRegistrationByMoid": { "operationId": "GetAssetDeviceRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Updates the resource representing the device connector. For example, this can be used to annotate the device connector resource with user-specified tags.", "operationId": "PatchAssetDeviceRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator", "UPDATE.asset.DeviceRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.DeviceRegistration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.DeviceRegistration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.DeviceRegistration' resource was patched as requested. The 'asset.DeviceRegistration' 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/asset.DeviceRegistration" } } }, "links": { "GetAssetDeviceRegistrationByMoid": { "operationId": "GetAssetDeviceRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/DeviceRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/GeoLocations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.GeoLocation' resource.", "operationId": "GetAssetGeoLocationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.asset.GeoLocation" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.GeoLocation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Create a 'asset.GeoLocation' resource.", "operationId": "CreateAssetGeoLocation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.GeoLocation", "PRIVSET.Account Administrator", "PRIVSET.Manage Geo Locations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.GeoLocation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.GeoLocation' resource was created as requested. The 'asset.GeoLocation' 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/asset.GeoLocation" } } }, "links": { "GetAssetGeoLocationByMoid": { "operationId": "GetAssetGeoLocationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/GeoLocations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/GeoLocations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.GeoLocation' resource.", "operationId": "GetAssetGeoLocationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.asset.GeoLocation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.GeoLocation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetGeoLocationByMoid": { "operationId": "GetAssetGeoLocationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/GeoLocations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.GeoLocation' resource.", "operationId": "UpdateAssetGeoLocation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Geo Locations", "ROLE.Account Administrator", "UPDATE.asset.GeoLocation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.GeoLocation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.GeoLocation' resource was modified as requested. The 'asset.GeoLocation' 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/asset.GeoLocation" } } }, "links": { "GetAssetGeoLocationByMoid": { "operationId": "GetAssetGeoLocationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/GeoLocations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.GeoLocation' resource.", "operationId": "PatchAssetGeoLocation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Geo Locations", "ROLE.Account Administrator", "UPDATE.asset.GeoLocation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.GeoLocation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.GeoLocation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.GeoLocation' resource was patched as requested. The 'asset.GeoLocation' 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/asset.GeoLocation" } } }, "links": { "GetAssetGeoLocationByMoid": { "operationId": "GetAssetGeoLocationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/GeoLocations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Delete a 'asset.GeoLocation' resource.", "operationId": "DeleteAssetGeoLocation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.asset.GeoLocation", "PRIVSET.Account Administrator", "PRIVSET.Manage Geo Locations", "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/asset/PreClaims": { "post": { "tags": [ "asset" ], "summary": "Create a 'asset.PreClaim' resource.", "operationId": "CreateAssetPreClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.PreClaim", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Complete Claim", "ROLE.Account Administrator", "ROLE.Complete Claim" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.PreClaim' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.PreClaim' resource was created as requested. The 'asset.PreClaim' 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/asset.PreClaim" } } }, "links": { "GetAssetPreClaimByMoid": { "operationId": "GetAssetPreClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/PreClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/PreClaims/{Moid}": { "post": { "tags": [ "asset" ], "summary": "Update a 'asset.PreClaim' resource.", "operationId": "UpdateAssetPreClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Complete Claim", "ROLE.Account Administrator", "ROLE.Complete Claim", "UPDATE.asset.PreClaim" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.PreClaim' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.PreClaim' resource was modified as requested. The 'asset.PreClaim' 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/asset.PreClaim" } } }, "links": { "GetAssetPreClaimByMoid": { "operationId": "GetAssetPreClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/PreClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.PreClaim' resource.", "operationId": "PatchAssetPreClaim", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Complete Claim", "ROLE.Account Administrator", "ROLE.Complete Claim", "UPDATE.asset.PreClaim" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.PreClaim' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.PreClaim" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.PreClaim' resource was patched as requested. The 'asset.PreClaim' 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/asset.PreClaim" } } }, "links": { "GetAssetPreClaimByMoid": { "operationId": "GetAssetPreClaimByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/PreClaims/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Subscriptions": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Subscription' resource.", "operationId": "GetAssetSubscriptionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.Subscription", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.Subscription' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Subscription.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Subscriptions/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Subscription' resource.", "operationId": "GetAssetSubscriptionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.Subscription", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.Subscription' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Subscription" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetSubscriptionByMoid": { "operationId": "GetAssetSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Subscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/SubscriptionAccounts": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.SubscriptionAccount' resource.", "operationId": "GetAssetSubscriptionAccountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.SubscriptionAccount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.SubscriptionAccount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.SubscriptionAccount.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/SubscriptionAccounts/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.SubscriptionAccount' resource.", "operationId": "GetAssetSubscriptionAccountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.asset.SubscriptionAccount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.SubscriptionAccount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.SubscriptionAccount" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetSubscriptionAccountByMoid": { "operationId": "GetAssetSubscriptionAccountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/SubscriptionAccounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/SubscriptionDeviceContractInformations": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.SubscriptionDeviceContractInformation' resource.", "operationId": "GetAssetSubscriptionDeviceContractInformationList", "deprecated": true, "x-sunset": "2027-03-01", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.SubscriptionDeviceContractInformation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.SubscriptionDeviceContractInformation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.SubscriptionDeviceContractInformation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/SubscriptionDeviceContractInformations/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.SubscriptionDeviceContractInformation' resource.", "operationId": "GetAssetSubscriptionDeviceContractInformationByMoid", "deprecated": true, "x-sunset": "2027-03-01", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Devices", "PRIVSET.View Servers", "READ.asset.SubscriptionDeviceContractInformation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.SubscriptionDeviceContractInformation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.SubscriptionDeviceContractInformation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetSubscriptionDeviceContractInformationByMoid": { "operationId": "GetAssetSubscriptionDeviceContractInformationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/SubscriptionDeviceContractInformations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Targets": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Target' resource.", "operationId": "GetAssetTargetList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.Read-only targets", "PRIVSET.View Devices", "READ.asset.Target", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'asset.Target' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Create a 'asset.Target' resource.", "operationId": "CreateAssetTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.asset.Target", "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'asset.Target' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.Target' resource was created as requested. The 'asset.Target' 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/asset.Target" } } }, "links": { "GetAssetTargetByMoid": { "operationId": "GetAssetTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Targets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/asset/Targets/{Moid}": { "get": { "tags": [ "asset" ], "summary": "Read a 'asset.Target' resource.", "operationId": "GetAssetTargetByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Delete Devices", "PRIVSET.Read-Only", "PRIVSET.Read-only targets", "PRIVSET.View Devices", "READ.asset.Target", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'asset.Target' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAssetTargetByMoid": { "operationId": "GetAssetTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Targets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.Target' resource.", "operationId": "UpdateAssetTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator", "UPDATE.asset.Target" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.Target' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.Target' resource was modified as requested. The 'asset.Target' 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/asset.Target" } } }, "links": { "GetAssetTargetByMoid": { "operationId": "GetAssetTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Targets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Update a 'asset.Target' resource.", "operationId": "PatchAssetTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim Devices", "PRIVSET.Claim targets", "ROLE.Account Administrator", "UPDATE.asset.Target" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'asset.Target' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asset.Target" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'asset.Target' resource was patched as requested. The 'asset.Target' 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/asset.Target" } } }, "links": { "GetAssetTargetByMoid": { "operationId": "GetAssetTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/asset/Targets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "asset" ], "summary": "Delete a 'asset.Target' resource.", "operationId": "DeleteAssetTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.asset.Target", "PRIVSET.Account Administrator", "PRIVSET.Delete Devices", "PRIVSET.Unclaim targets", "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/auditd/Policies": { "get": { "tags": [ "auditd" ], "summary": "Read a 'auditd.Policy' resource.", "operationId": "GetAuditdPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only AuditD policies", "PRIVSET.View Switch Profiles", "READ.auditd.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 'auditd.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/auditd.Policy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "auditd" ], "summary": "Create a 'auditd.Policy' resource.", "operationId": "CreateAuditdPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.auditd.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit AuditD policies", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'auditd.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditd.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'auditd.Policy' resource was created as requested. The 'auditd.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/auditd.Policy" } } }, "links": { "GetAuditdPolicyByMoid": { "operationId": "GetAuditdPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/auditd/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/auditd/Policies/{Moid}": { "get": { "tags": [ "auditd" ], "summary": "Read a 'auditd.Policy' resource.", "operationId": "GetAuditdPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only AuditD policies", "PRIVSET.View Switch Profiles", "READ.auditd.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 'auditd.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/auditd.Policy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetAuditdPolicyByMoid": { "operationId": "GetAuditdPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/auditd/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": [ "auditd" ], "summary": "Update a 'auditd.Policy' resource.", "operationId": "UpdateAuditdPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit AuditD policies", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.auditd.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'auditd.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditd.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'auditd.Policy' resource was modified as requested. The 'auditd.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/auditd.Policy" } } }, "links": { "GetAuditdPolicyByMoid": { "operationId": "GetAuditdPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/auditd/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": [ "auditd" ], "summary": "Update a 'auditd.Policy' resource.", "operationId": "PatchAuditdPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit AuditD policies", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.auditd.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'auditd.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditd.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'auditd.Policy' resource was patched as requested. The 'auditd.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/auditd.Policy" } } }, "links": { "GetAuditdPolicyByMoid": { "operationId": "GetAuditdPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/auditd/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": [ "auditd" ], "summary": "Delete a 'auditd.Policy' resource.", "operationId": "DeleteAuditdPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.auditd.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete AuditD policies", "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/bulk/Exports": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.Export' resource.", "operationId": "GetBulkExportList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Exports", "PRIVSET.Manage Workflow Definitions", "PRIVSET.View Exports", "READ.bulk.Export", "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 'bulk.Export' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Export.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "bulk" ], "summary": "Create a 'bulk.Export' resource.", "operationId": "CreateBulkExport", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.bulk.Export", "PRIVSET.Account Administrator", "PRIVSET.Manage Exports", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'bulk.Export' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Export" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bulk.Export' resource was created as requested. The 'bulk.Export' 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/bulk.Export" } } }, "links": { "GetBulkExportByMoid": { "operationId": "GetBulkExportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/Exports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/Exports/{Moid}": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.Export' resource.", "operationId": "GetBulkExportByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Exports", "PRIVSET.Manage Workflow Definitions", "PRIVSET.View Exports", "READ.bulk.Export", "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 'bulk.Export' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Export" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetBulkExportByMoid": { "operationId": "GetBulkExportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/Exports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "bulk" ], "summary": "Update a 'bulk.Export' resource.", "operationId": "UpdateBulkExport", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Exports", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.bulk.Export" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'bulk.Export' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Export" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bulk.Export' resource was modified as requested. The 'bulk.Export' 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/bulk.Export" } } }, "links": { "GetBulkExportByMoid": { "operationId": "GetBulkExportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/Exports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "bulk" ], "summary": "Update a 'bulk.Export' resource.", "operationId": "PatchBulkExport", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Exports", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.bulk.Export" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'bulk.Export' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Export" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bulk.Export' resource was patched as requested. The 'bulk.Export' 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/bulk.Export" } } }, "links": { "GetBulkExportByMoid": { "operationId": "GetBulkExportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/Exports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "bulk" ], "summary": "Delete a 'bulk.Export' resource.", "operationId": "DeleteBulkExport", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.bulk.Export", "PRIVSET.Account Administrator", "PRIVSET.Manage Exports", "PRIVSET.Manage Workflow Definitions", "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/bulk/ExportedItems": { "get": { "tags": [ "bulk" ], "x-intersight-type": "SaaS", "summary": "Read a 'bulk.ExportedItem' resource.", "operationId": "GetBulkExportedItemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.View Exports", "READ.bulk.ExportedItem", "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 'bulk.ExportedItem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.ExportedItem.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/ExportedItems/{Moid}": { "get": { "tags": [ "bulk" ], "x-intersight-type": "SaaS", "summary": "Read a 'bulk.ExportedItem' resource.", "operationId": "GetBulkExportedItemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "PRIVSET.View Exports", "READ.bulk.ExportedItem", "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 'bulk.ExportedItem' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.ExportedItem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetBulkExportedItemByMoid": { "operationId": "GetBulkExportedItemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/ExportedItems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/MoCloners": { "post": { "tags": [ "bulk" ], "summary": "Create a 'bulk.MoCloner' resource.", "operationId": "CreateBulkMoCloner", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.bulk.MoCloner", "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The 'bulk.MoCloner' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoCloner" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bulk.MoCloner' resource was created as requested. The 'bulk.MoCloner' 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/bulk.MoCloner" } } }, "links": { "GetBulkMoClonerByMoid": { "operationId": "GetBulkMoClonerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoCloners/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "202": { "description": "The HTTP 202 status response code indicates that the request has succeeded. The 'bulk.MoCloner' resource is asynchronously being created as requested.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoCloner" } } }, "links": { "GetBulkMoClonerByMoid": { "operationId": "GetBulkMoClonerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoCloners/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "bulk" ], "summary": "Read a 'bulk.MoCloner' resource.", "operationId": "GetBulkMoClonerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.MoCloner" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bulk.MoCloner' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoCloner.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/MoCloners/{Moid}": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.MoCloner' resource.", "operationId": "GetBulkMoClonerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.MoCloner" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bulk.MoCloner' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoCloner" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetBulkMoClonerByMoid": { "operationId": "GetBulkMoClonerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoCloners/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/MoDeepCloners": { "post": { "tags": [ "bulk" ], "summary": "Create a 'bulk.MoDeepCloner' resource.", "operationId": "CreateBulkMoDeepCloner", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.bulk.MoDeepCloner", "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The 'bulk.MoDeepCloner' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoDeepCloner" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bulk.MoDeepCloner' resource was created as requested. The 'bulk.MoDeepCloner' 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/bulk.MoDeepCloner" } } }, "links": { "GetBulkMoDeepClonerByMoid": { "operationId": "GetBulkMoDeepClonerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoDeepCloners/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "202": { "description": "The HTTP 202 status response code indicates that the request has succeeded. The 'bulk.MoDeepCloner' resource is asynchronously being created as requested.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoDeepCloner" } } }, "links": { "GetBulkMoDeepClonerByMoid": { "operationId": "GetBulkMoDeepClonerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoDeepCloners/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "bulk" ], "summary": "Read a 'bulk.MoDeepCloner' resource.", "operationId": "GetBulkMoDeepClonerList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.MoDeepCloner" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bulk.MoDeepCloner' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoDeepCloner.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/MoDeepCloners/{Moid}": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.MoDeepCloner' resource.", "operationId": "GetBulkMoDeepClonerByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.MoDeepCloner" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bulk.MoDeepCloner' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoDeepCloner" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetBulkMoDeepClonerByMoid": { "operationId": "GetBulkMoDeepClonerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoDeepCloners/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/MoMergers": { "post": { "tags": [ "bulk" ], "summary": "Create a 'bulk.MoMerger' resource.", "operationId": "CreateBulkMoMerger", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.bulk.MoMerger", "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The 'bulk.MoMerger' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoMerger" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bulk.MoMerger' resource was created as requested. The 'bulk.MoMerger' 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/bulk.MoMerger" } } }, "links": { "GetBulkMoMergerByMoid": { "operationId": "GetBulkMoMergerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoMergers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "202": { "description": "The HTTP 202 status response code indicates that the request has succeeded. The 'bulk.MoMerger' resource is asynchronously being created as requested.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoMerger" } } }, "links": { "GetBulkMoMergerByMoid": { "operationId": "GetBulkMoMergerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoMergers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "bulk" ], "summary": "Read a 'bulk.MoMerger' resource.", "operationId": "GetBulkMoMergerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.MoMerger" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bulk.MoMerger' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoMerger.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/MoMergers/{Moid}": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.MoMerger' resource.", "operationId": "GetBulkMoMergerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.MoMerger" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bulk.MoMerger' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.MoMerger" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetBulkMoMergerByMoid": { "operationId": "GetBulkMoMergerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/MoMergers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/Requests": { "post": { "tags": [ "bulk" ], "summary": "Create a 'bulk.Request' resource.", "operationId": "CreateBulkRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.bulk.Request", "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The 'bulk.Request' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Request" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bulk.Request' resource was created as requested. The 'bulk.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/bulk.Request" } } }, "links": { "GetBulkRequestByMoid": { "operationId": "GetBulkRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/Requests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "202": { "description": "The HTTP 202 status response code indicates that the request has succeeded. The 'bulk.Request' resource is asynchronously being created as requested.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Request" } } }, "links": { "GetBulkRequestByMoid": { "operationId": "GetBulkRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/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" } } }, "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.Request' resource.", "operationId": "GetBulkRequestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.Request" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bulk.Request' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Request.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/Requests/{Moid}": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.Request' resource.", "operationId": "GetBulkRequestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.Request" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bulk.Request' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Request" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetBulkRequestByMoid": { "operationId": "GetBulkRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/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/bulk/Results": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.Result' resource.", "operationId": "GetBulkResultList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.Result" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bulk.Result' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Result.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/Results/{Moid}": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.Result' resource.", "operationId": "GetBulkResultByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.bulk.Result" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bulk.Result' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.Result" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetBulkResultByMoid": { "operationId": "GetBulkResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/Results/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/SubRequestObjs": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.SubRequestObj' resource.", "operationId": "GetBulkSubRequestObjList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.bulk.SubRequestObj" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bulk.SubRequestObj' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.SubRequestObj.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bulk/SubRequestObjs/{Moid}": { "get": { "tags": [ "bulk" ], "summary": "Read a 'bulk.SubRequestObj' resource.", "operationId": "GetBulkSubRequestObjByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.bulk.SubRequestObj" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bulk.SubRequestObj' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk.SubRequestObj" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetBulkSubRequestObjByMoid": { "operationId": "GetBulkSubRequestObjByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bulk/SubRequestObjs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cli/CliPolicies": { "get": { "tags": [ "cli" ], "summary": "Read a 'cli.CliPolicy' resource.", "operationId": "GetCliCliPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Allow/disallow FI and Unified Edge eCMC CLI launches", "PRIVSET.Launch CLI as admin", "PRIVSET.Launch CLI as read-only", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only CLI policies", "PRIVSET.View Servers", "READ.cli.CliPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cli.CliPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cli.CliPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cli" ], "summary": "Create a 'cli.CliPolicy' resource.", "operationId": "CreateCliCliPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cli.CliPolicy", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cli.CliPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cli.CliPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cli.CliPolicy' resource was created as requested. The 'cli.CliPolicy' 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/cli.CliPolicy" } } }, "links": { "GetCliCliPolicyByMoid": { "operationId": "GetCliCliPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cli/CliPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cli/CliPolicies/{Moid}": { "get": { "tags": [ "cli" ], "summary": "Read a 'cli.CliPolicy' resource.", "operationId": "GetCliCliPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Allow/disallow FI and Unified Edge eCMC CLI launches", "PRIVSET.Launch CLI as admin", "PRIVSET.Launch CLI as read-only", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only CLI policies", "PRIVSET.View Servers", "READ.cli.CliPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cli.CliPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cli.CliPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCliCliPolicyByMoid": { "operationId": "GetCliCliPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cli/CliPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cli" ], "summary": "Update a 'cli.CliPolicy' resource.", "operationId": "UpdateCliCliPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.cli.CliPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cli.CliPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cli.CliPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cli.CliPolicy' resource was modified as requested. The 'cli.CliPolicy' 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/cli.CliPolicy" } } }, "links": { "GetCliCliPolicyByMoid": { "operationId": "GetCliCliPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cli/CliPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cli" ], "summary": "Update a 'cli.CliPolicy' resource.", "operationId": "PatchCliCliPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.cli.CliPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cli.CliPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cli.CliPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cli.CliPolicy' resource was patched as requested. The 'cli.CliPolicy' 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/cli.CliPolicy" } } }, "links": { "GetCliCliPolicyByMoid": { "operationId": "GetCliCliPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cli/CliPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cli" ], "summary": "Delete a 'cli.CliPolicy' resource.", "operationId": "DeleteCliCliPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.cli.CliPolicy", "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/cloud/CollectInventories": { "post": { "tags": [ "cloud" ], "x-intersight-type": "SaaS", "summary": "Create a 'cloud.CollectInventory' resource.", "operationId": "CreateCloudCollectInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cloud.CollectInventory", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cloud.CollectInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud.CollectInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cloud.CollectInventory' resource was created as requested. The 'cloud.CollectInventory' 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/cloud.CollectInventory" } } }, "links": { "GetCloudCollectInventoryByMoid": { "operationId": "GetCloudCollectInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cloud/CollectInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cloud/TfcAgentpools": { "get": { "tags": [ "cloud" ], "x-intersight-type": "SaaS", "summary": "Read a 'cloud.TfcAgentpool' resource.", "operationId": "GetCloudTfcAgentpoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.cloud.TfcAgentpool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cloud.TfcAgentpool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud.TfcAgentpool.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cloud/TfcAgentpools/{Moid}": { "get": { "tags": [ "cloud" ], "x-intersight-type": "SaaS", "summary": "Read a 'cloud.TfcAgentpool' resource.", "operationId": "GetCloudTfcAgentpoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.cloud.TfcAgentpool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cloud.TfcAgentpool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud.TfcAgentpool" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCloudTfcAgentpoolByMoid": { "operationId": "GetCloudTfcAgentpoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cloud/TfcAgentpools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cloud/TfcOrganizations": { "get": { "tags": [ "cloud" ], "x-intersight-type": "SaaS", "summary": "Read a 'cloud.TfcOrganization' resource.", "operationId": "GetCloudTfcOrganizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.cloud.TfcOrganization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cloud.TfcOrganization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud.TfcOrganization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cloud/TfcOrganizations/{Moid}": { "get": { "tags": [ "cloud" ], "x-intersight-type": "SaaS", "summary": "Read a 'cloud.TfcOrganization' resource.", "operationId": "GetCloudTfcOrganizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.cloud.TfcOrganization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cloud.TfcOrganization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud.TfcOrganization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCloudTfcOrganizationByMoid": { "operationId": "GetCloudTfcOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cloud/TfcOrganizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cloud/TfcWorkspaces": { "get": { "tags": [ "cloud" ], "x-intersight-type": "SaaS", "summary": "Read a 'cloud.TfcWorkspace' resource.", "operationId": "GetCloudTfcWorkspaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.cloud.TfcWorkspace", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cloud.TfcWorkspace' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud.TfcWorkspace.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cloud/TfcWorkspaces/{Moid}": { "get": { "tags": [ "cloud" ], "x-intersight-type": "SaaS", "summary": "Read a 'cloud.TfcWorkspace' resource.", "operationId": "GetCloudTfcWorkspaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.cloud.TfcWorkspace", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cloud.TfcWorkspace' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cloud.TfcWorkspace" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCloudTfcWorkspaceByMoid": { "operationId": "GetCloudTfcWorkspaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cloud/TfcWorkspaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/Alarms": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.Alarm' resource.", "operationId": "GetCondAlarmList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HCI Clusters", "PRIVSET.Manage Servers", "PRIVSET.Network Administrator", "PRIVSET.Network Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only all alarms", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HCI Clusters", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.cond.Alarm", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Network Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.Alarm' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.Alarm.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/Alarms/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.Alarm' resource.", "operationId": "GetCondAlarmByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HCI Clusters", "PRIVSET.Manage Servers", "PRIVSET.Network Administrator", "PRIVSET.Network Operator", "PRIVSET.Read-Only", "PRIVSET.Read-only all alarms", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HCI Clusters", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.cond.Alarm", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Network Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.Alarm' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.Alarm" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondAlarmByMoid": { "operationId": "GetCondAlarmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/Alarms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.Alarm' resource.", "operationId": "UpdateCondAlarm", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.cond.Alarm" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.Alarm' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.Alarm" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.Alarm' resource was modified as requested. The 'cond.Alarm' 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/cond.Alarm" } } }, "links": { "GetCondAlarmByMoid": { "operationId": "GetCondAlarmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/Alarms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.Alarm' resource.", "operationId": "PatchCondAlarm", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.cond.Alarm" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.Alarm' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.Alarm" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.Alarm' resource was patched as requested. The 'cond.Alarm' 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/cond.Alarm" } } }, "links": { "GetCondAlarmByMoid": { "operationId": "GetCondAlarmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/Alarms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmAggregations": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmAggregation' resource.", "operationId": "GetCondAlarmAggregationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HCI Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all alarms", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HCI Clusters", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.cond.AlarmAggregation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.AlarmAggregation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmAggregation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmAggregations/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmAggregation' resource.", "operationId": "GetCondAlarmAggregationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HCI Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all alarms", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HCI Clusters", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.cond.AlarmAggregation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.AlarmAggregation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmAggregation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondAlarmAggregationByMoid": { "operationId": "GetCondAlarmAggregationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmAggregations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmClassifications": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmClassification' resource.", "operationId": "GetCondAlarmClassificationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.cond.AlarmClassification" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.AlarmClassification' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmClassification.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmClassifications/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmClassification' resource.", "operationId": "GetCondAlarmClassificationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.cond.AlarmClassification" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.AlarmClassification' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmClassification" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondAlarmClassificationByMoid": { "operationId": "GetCondAlarmClassificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmClassifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmDefinitions": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmDefinition' resource.", "operationId": "GetCondAlarmDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.cond.AlarmDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.AlarmDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmDefinition.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmDefinitions/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmDefinition' resource.", "operationId": "GetCondAlarmDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.cond.AlarmDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.AlarmDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmDefinition" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondAlarmDefinitionByMoid": { "operationId": "GetCondAlarmDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmRules": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmRule' resource.", "operationId": "GetCondAlarmRuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.cond.AlarmRule" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.AlarmRule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmRule.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Create a 'cond.AlarmRule' resource.", "operationId": "CreateCondAlarmRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cond.AlarmRule", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cond.AlarmRule' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmRule" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.AlarmRule' resource was created as requested. The 'cond.AlarmRule' 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/cond.AlarmRule" } } }, "links": { "GetCondAlarmRuleByMoid": { "operationId": "GetCondAlarmRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmRules/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmRule' resource.", "operationId": "GetCondAlarmRuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.cond.AlarmRule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.AlarmRule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmRule" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondAlarmRuleByMoid": { "operationId": "GetCondAlarmRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.AlarmRule' resource.", "operationId": "UpdateCondAlarmRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.cond.AlarmRule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.AlarmRule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmRule" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.AlarmRule' resource was modified as requested. The 'cond.AlarmRule' 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/cond.AlarmRule" } } }, "links": { "GetCondAlarmRuleByMoid": { "operationId": "GetCondAlarmRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.AlarmRule' resource.", "operationId": "PatchCondAlarmRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.cond.AlarmRule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.AlarmRule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmRule" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.AlarmRule' resource was patched as requested. The 'cond.AlarmRule' 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/cond.AlarmRule" } } }, "links": { "GetCondAlarmRuleByMoid": { "operationId": "GetCondAlarmRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Delete a 'cond.AlarmRule' resource.", "operationId": "DeleteCondAlarmRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.cond.AlarmRule", "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/cond/AlarmSuppressions": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmSuppression' resource.", "operationId": "GetCondAlarmSuppressionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all alarms", "PRIVSET.View Servers", "READ.cond.AlarmSuppression", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.AlarmSuppression' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmSuppression.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Create a 'cond.AlarmSuppression' resource.", "operationId": "CreateCondAlarmSuppression", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cond.AlarmSuppression", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage alarm suppression", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cond.AlarmSuppression' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmSuppression" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.AlarmSuppression' resource was created as requested. The 'cond.AlarmSuppression' 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/cond.AlarmSuppression" } } }, "links": { "GetCondAlarmSuppressionByMoid": { "operationId": "GetCondAlarmSuppressionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmSuppressions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/AlarmSuppressions/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.AlarmSuppression' resource.", "operationId": "GetCondAlarmSuppressionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all alarms", "PRIVSET.View Servers", "READ.cond.AlarmSuppression", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.AlarmSuppression' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmSuppression" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondAlarmSuppressionByMoid": { "operationId": "GetCondAlarmSuppressionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmSuppressions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.AlarmSuppression' resource.", "operationId": "UpdateCondAlarmSuppression", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage alarm suppression", "ROLE.Account Administrator", "UPDATE.cond.AlarmSuppression" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.AlarmSuppression' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmSuppression" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.AlarmSuppression' resource was modified as requested. The 'cond.AlarmSuppression' 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/cond.AlarmSuppression" } } }, "links": { "GetCondAlarmSuppressionByMoid": { "operationId": "GetCondAlarmSuppressionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmSuppressions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.AlarmSuppression' resource.", "operationId": "PatchCondAlarmSuppression", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage alarm suppression", "ROLE.Account Administrator", "UPDATE.cond.AlarmSuppression" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.AlarmSuppression' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmSuppression" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.AlarmSuppression' resource was patched as requested. The 'cond.AlarmSuppression' 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/cond.AlarmSuppression" } } }, "links": { "GetCondAlarmSuppressionByMoid": { "operationId": "GetCondAlarmSuppressionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmSuppressions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Delete a 'cond.AlarmSuppression' resource.", "operationId": "DeleteCondAlarmSuppression", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.cond.AlarmSuppression", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage alarm suppression", "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/cond/AlarmSuppressionDryRuns": { "post": { "tags": [ "cond" ], "summary": "Create a 'cond.AlarmSuppressionDryRun' resource.", "operationId": "CreateCondAlarmSuppressionDryRun", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cond.AlarmSuppressionDryRun", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cond.AlarmSuppressionDryRun' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.AlarmSuppressionDryRun" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.AlarmSuppressionDryRun' resource was created as requested. The 'cond.AlarmSuppressionDryRun' 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/cond.AlarmSuppressionDryRun" } } }, "links": { "GetCondAlarmSuppressionDryRunByMoid": { "operationId": "GetCondAlarmSuppressionDryRunByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/AlarmSuppressionDryRuns/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/CustomHclBaselines": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.CustomHclBaseline' resource.", "operationId": "GetCondCustomHclBaselineList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.CustomHclBaseline", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.CustomHclBaseline' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.CustomHclBaseline.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Create a 'cond.CustomHclBaseline' resource.", "operationId": "CreateCondCustomHclBaseline", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cond.CustomHclBaseline", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cond.CustomHclBaseline' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.CustomHclBaseline" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.CustomHclBaseline' resource was created as requested. The 'cond.CustomHclBaseline' 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/cond.CustomHclBaseline" } } }, "links": { "GetCondCustomHclBaselineByMoid": { "operationId": "GetCondCustomHclBaselineByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/CustomHclBaselines/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/CustomHclBaselines/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.CustomHclBaseline' resource.", "operationId": "GetCondCustomHclBaselineByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.CustomHclBaseline", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.CustomHclBaseline' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.CustomHclBaseline" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondCustomHclBaselineByMoid": { "operationId": "GetCondCustomHclBaselineByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/CustomHclBaselines/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.CustomHclBaseline' resource.", "operationId": "UpdateCondCustomHclBaseline", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.cond.CustomHclBaseline" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.CustomHclBaseline' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.CustomHclBaseline" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.CustomHclBaseline' resource was modified as requested. The 'cond.CustomHclBaseline' 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/cond.CustomHclBaseline" } } }, "links": { "GetCondCustomHclBaselineByMoid": { "operationId": "GetCondCustomHclBaselineByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/CustomHclBaselines/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.CustomHclBaseline' resource.", "operationId": "PatchCondCustomHclBaseline", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.cond.CustomHclBaseline" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.CustomHclBaseline' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.CustomHclBaseline" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.CustomHclBaseline' resource was patched as requested. The 'cond.CustomHclBaseline' 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/cond.CustomHclBaseline" } } }, "links": { "GetCondCustomHclBaselineByMoid": { "operationId": "GetCondCustomHclBaselineByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/CustomHclBaselines/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Delete a 'cond.CustomHclBaseline' resource.", "operationId": "DeleteCondCustomHclBaseline", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.cond.CustomHclBaseline", "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/cond/CustomHclStatuses": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.CustomHclStatus' resource.", "operationId": "GetCondCustomHclStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.CustomHclStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.CustomHclStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.CustomHclStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Create a 'cond.CustomHclStatus' resource.", "operationId": "CreateCondCustomHclStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cond.CustomHclStatus", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cond.CustomHclStatus' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.CustomHclStatus" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.CustomHclStatus' resource was created as requested. The 'cond.CustomHclStatus' 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/cond.CustomHclStatus" } } }, "links": { "GetCondCustomHclStatusByMoid": { "operationId": "GetCondCustomHclStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/CustomHclStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/CustomHclStatuses/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.CustomHclStatus' resource.", "operationId": "GetCondCustomHclStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.CustomHclStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.CustomHclStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.CustomHclStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondCustomHclStatusByMoid": { "operationId": "GetCondCustomHclStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/CustomHclStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/HclStatuses": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.HclStatus' resource.", "operationId": "GetCondHclStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.HclStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.HclStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.HclStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/HclStatuses/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.HclStatus' resource.", "operationId": "GetCondHclStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.HclStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.HclStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.HclStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondHclStatusByMoid": { "operationId": "GetCondHclStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/HclStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/HclStatusDetails": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.HclStatusDetail' resource.", "operationId": "GetCondHclStatusDetailList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.HclStatusDetail", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.HclStatusDetail' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.HclStatusDetail.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/HclStatusDetails/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.HclStatusDetail' resource.", "operationId": "GetCondHclStatusDetailByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.HclStatusDetail", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.HclStatusDetail' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.HclStatusDetail" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondHclStatusDetailByMoid": { "operationId": "GetCondHclStatusDetailByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/HclStatusDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/HclStatusJobs": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.HclStatusJob' resource.", "operationId": "GetCondHclStatusJobList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.HclStatusJob", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.HclStatusJob' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.HclStatusJob.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Create a 'cond.HclStatusJob' resource.", "operationId": "CreateCondHclStatusJob", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cond.HclStatusJob", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cond.HclStatusJob' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.HclStatusJob" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.HclStatusJob' resource was created as requested. The 'cond.HclStatusJob' 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/cond.HclStatusJob" } } }, "links": { "GetCondHclStatusJobByMoid": { "operationId": "GetCondHclStatusJobByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/HclStatusJobs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/HclStatusJobs/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.HclStatusJob' resource.", "operationId": "GetCondHclStatusJobByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.cond.HclStatusJob", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.HclStatusJob' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.HclStatusJob" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondHclStatusJobByMoid": { "operationId": "GetCondHclStatusJobByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/HclStatusJobs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/ThresholdDefinitions": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.ThresholdDefinition' resource.", "operationId": "GetCondThresholdDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.cond.ThresholdDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'cond.ThresholdDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.ThresholdDefinition.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Create a 'cond.ThresholdDefinition' resource.", "operationId": "CreateCondThresholdDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.cond.ThresholdDefinition", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'cond.ThresholdDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.ThresholdDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.ThresholdDefinition' resource was created as requested. The 'cond.ThresholdDefinition' 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/cond.ThresholdDefinition" } } }, "links": { "GetCondThresholdDefinitionByMoid": { "operationId": "GetCondThresholdDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/ThresholdDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/cond/ThresholdDefinitions/{Moid}": { "get": { "tags": [ "cond" ], "summary": "Read a 'cond.ThresholdDefinition' resource.", "operationId": "GetCondThresholdDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.cond.ThresholdDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'cond.ThresholdDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.ThresholdDefinition" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCondThresholdDefinitionByMoid": { "operationId": "GetCondThresholdDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/ThresholdDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.ThresholdDefinition' resource.", "operationId": "UpdateCondThresholdDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.cond.ThresholdDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.ThresholdDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.ThresholdDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.ThresholdDefinition' resource was modified as requested. The 'cond.ThresholdDefinition' 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/cond.ThresholdDefinition" } } }, "links": { "GetCondThresholdDefinitionByMoid": { "operationId": "GetCondThresholdDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/ThresholdDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Update a 'cond.ThresholdDefinition' resource.", "operationId": "PatchCondThresholdDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.cond.ThresholdDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'cond.ThresholdDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cond.ThresholdDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'cond.ThresholdDefinition' resource was patched as requested. The 'cond.ThresholdDefinition' 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/cond.ThresholdDefinition" } } }, "links": { "GetCondThresholdDefinitionByMoid": { "operationId": "GetCondThresholdDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/cond/ThresholdDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "cond" ], "summary": "Delete a 'cond.ThresholdDefinition' resource.", "operationId": "DeleteCondThresholdDefinition", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.cond.ThresholdDefinition", "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/coremanagement/CoreFiles": { "get": { "tags": [ "coremanagement" ], "summary": "Read a 'coremanagement.CoreFile' resource.", "operationId": "GetCoremanagementCoreFileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Servers", "READ.coremanagement.CoreFile", "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 'coremanagement.CoreFile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coremanagement.CoreFile.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/coremanagement/CoreFiles/{Moid}": { "get": { "tags": [ "coremanagement" ], "summary": "Read a 'coremanagement.CoreFile' resource.", "operationId": "GetCoremanagementCoreFileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Servers", "READ.coremanagement.CoreFile", "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 'coremanagement.CoreFile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coremanagement.CoreFile" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCoremanagementCoreFileByMoid": { "operationId": "GetCoremanagementCoreFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/coremanagement/CoreFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "coremanagement" ], "summary": "Delete a 'coremanagement.CoreFile' resource.", "operationId": "DeleteCoremanagementCoreFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.coremanagement.CoreFile", "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" } } }, "post": { "tags": [ "coremanagement" ], "summary": "Update a 'coremanagement.CoreFile' resource.", "operationId": "UpdateCoremanagementCoreFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Servers", "ROLE.Account Administrator", "UPDATE.coremanagement.CoreFile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'coremanagement.CoreFile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coremanagement.CoreFile" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'coremanagement.CoreFile' resource was modified as requested. The 'coremanagement.CoreFile' 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/coremanagement.CoreFile" } } }, "links": { "GetCoremanagementCoreFileByMoid": { "operationId": "GetCoremanagementCoreFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/coremanagement/CoreFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "coremanagement" ], "summary": "Update a 'coremanagement.CoreFile' resource.", "operationId": "PatchCoremanagementCoreFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Servers", "ROLE.Account Administrator", "UPDATE.coremanagement.CoreFile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'coremanagement.CoreFile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coremanagement.CoreFile" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'coremanagement.CoreFile' resource was patched as requested. The 'coremanagement.CoreFile' 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/coremanagement.CoreFile" } } }, "links": { "GetCoremanagementCoreFileByMoid": { "operationId": "GetCoremanagementCoreFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/coremanagement/CoreFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/coremanagement/Downloads": { "get": { "tags": [ "coremanagement" ], "summary": "Read a 'coremanagement.Download' resource.", "operationId": "GetCoremanagementDownloadList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Servers", "READ.coremanagement.Download", "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 'coremanagement.Download' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coremanagement.Download.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/coremanagement/Downloads/{Moid}": { "get": { "tags": [ "coremanagement" ], "summary": "Read a 'coremanagement.Download' resource.", "operationId": "GetCoremanagementDownloadByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Servers", "READ.coremanagement.Download", "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 'coremanagement.Download' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/coremanagement.Download" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetCoremanagementDownloadByMoid": { "operationId": "GetCoremanagementDownloadByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/coremanagement/Downloads/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/externalsite/Authorizations": { "post": { "tags": [ "externalsite" ], "summary": "Create a 'externalsite.Authorization' resource.", "operationId": "CreateExternalsiteAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.externalsite.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'externalsite.Authorization' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/externalsite.Authorization" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'externalsite.Authorization' resource was created as requested. The 'externalsite.Authorization' 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/externalsite.Authorization" } } }, "links": { "GetExternalsiteAuthorizationByMoid": { "operationId": "GetExternalsiteAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "externalsite" ], "summary": "Read a 'externalsite.Authorization' resource.", "operationId": "GetExternalsiteAuthorizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.externalsite.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'externalsite.Authorization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/externalsite.Authorization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/externalsite/Authorizations/{Moid}": { "post": { "tags": [ "externalsite" ], "summary": "Update a 'externalsite.Authorization' resource.", "operationId": "UpdateExternalsiteAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.externalsite.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'externalsite.Authorization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/externalsite.Authorization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'externalsite.Authorization' resource was modified as requested. The 'externalsite.Authorization' 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/externalsite.Authorization" } } }, "links": { "GetExternalsiteAuthorizationByMoid": { "operationId": "GetExternalsiteAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "externalsite" ], "summary": "Update a 'externalsite.Authorization' resource.", "operationId": "PatchExternalsiteAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.externalsite.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'externalsite.Authorization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/externalsite.Authorization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'externalsite.Authorization' resource was patched as requested. The 'externalsite.Authorization' 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/externalsite.Authorization" } } }, "links": { "GetExternalsiteAuthorizationByMoid": { "operationId": "GetExternalsiteAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "externalsite" ], "summary": "Read a 'externalsite.Authorization' resource.", "operationId": "GetExternalsiteAuthorizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.externalsite.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'externalsite.Authorization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/externalsite.Authorization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetExternalsiteAuthorizationByMoid": { "operationId": "GetExternalsiteAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/externalsite/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/feedback/FeedbackPosts": { "post": { "tags": [ "feedback" ], "summary": "Create a 'feedback.FeedbackPost' resource.", "operationId": "CreateFeedbackFeedbackPost", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.feedback.FeedbackPost", "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'feedback.FeedbackPost' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'feedback.FeedbackPost' resource was created as requested. The 'feedback.FeedbackPost' 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/feedback.FeedbackPost" } } }, "links": { "GetFeedbackFeedbackPostByMoid": { "operationId": "GetFeedbackFeedbackPostByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/feedback/FeedbackPosts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/feedback/FeedbackPosts/{Moid}": { "post": { "tags": [ "feedback" ], "summary": "Update a 'feedback.FeedbackPost' resource.", "operationId": "UpdateFeedbackFeedbackPost", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.feedback.FeedbackPost" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'feedback.FeedbackPost' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'feedback.FeedbackPost' resource was modified as requested. The 'feedback.FeedbackPost' 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/feedback.FeedbackPost" } } }, "links": { "GetFeedbackFeedbackPostByMoid": { "operationId": "GetFeedbackFeedbackPostByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/feedback/FeedbackPosts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "feedback" ], "summary": "Update a 'feedback.FeedbackPost' resource.", "operationId": "PatchFeedbackFeedbackPost", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.feedback.FeedbackPost" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'feedback.FeedbackPost' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/feedback.FeedbackPost" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'feedback.FeedbackPost' resource was patched as requested. The 'feedback.FeedbackPost' 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/feedback.FeedbackPost" } } }, "links": { "GetFeedbackFeedbackPostByMoid": { "operationId": "GetFeedbackFeedbackPostByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/feedback/FeedbackPosts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/AhvVms": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.AhvVm' resource.", "operationId": "GetHciAhvVmList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.AhvVm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.AhvVm' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVm.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/AhvVms/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.AhvVm' resource.", "operationId": "GetHciAhvVmByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.AhvVm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.AhvVm' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVm" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciAhvVmByMoid": { "operationId": "GetHciAhvVmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/AhvVms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "hci" ], "summary": "Update a 'hci.AhvVm' resource.", "operationId": "UpdateHciAhvVm", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.AhvVm" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.AhvVm' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVm" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.AhvVm' resource was modified as requested. The 'hci.AhvVm' 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/hci.AhvVm" } } }, "links": { "GetHciAhvVmByMoid": { "operationId": "GetHciAhvVmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/AhvVms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "hci" ], "summary": "Update a 'hci.AhvVm' resource.", "operationId": "PatchHciAhvVm", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.AhvVm" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.AhvVm' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVm" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.AhvVm' resource was patched as requested. The 'hci.AhvVm' 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/hci.AhvVm" } } }, "links": { "GetHciAhvVmByMoid": { "operationId": "GetHciAhvVmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/AhvVms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/AhvVmDisks": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.AhvVmDisk' resource.", "operationId": "GetHciAhvVmDiskList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.AhvVmDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.AhvVmDisk' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVmDisk.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/AhvVmDisks/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.AhvVmDisk' resource.", "operationId": "GetHciAhvVmDiskByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.AhvVmDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.AhvVmDisk' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVmDisk" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciAhvVmDiskByMoid": { "operationId": "GetHciAhvVmDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/AhvVmDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/AhvVmGpus": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.AhvVmGpu' resource.", "operationId": "GetHciAhvVmGpuList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.AhvVmGpu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.AhvVmGpu' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVmGpu.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/AhvVmGpus/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.AhvVmGpu' resource.", "operationId": "GetHciAhvVmGpuByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.AhvVmGpu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.AhvVmGpu' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVmGpu" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciAhvVmGpuByMoid": { "operationId": "GetHciAhvVmGpuByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/AhvVmGpus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/AhvVmNics": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.AhvVmNic' resource.", "operationId": "GetHciAhvVmNicList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.AhvVmNic", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.AhvVmNic' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVmNic.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/AhvVmNics/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.AhvVmNic' resource.", "operationId": "GetHciAhvVmNicByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.AhvVmNic", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.AhvVmNic' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.AhvVmNic" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciAhvVmNicByMoid": { "operationId": "GetHciAhvVmNicByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/AhvVmNics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Alarms": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Alarm' resource.", "operationId": "GetHciAlarmList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Alarm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.Alarm' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Alarm.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Alarms/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Alarm' resource.", "operationId": "GetHciAlarmByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Alarm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.Alarm' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Alarm" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciAlarmByMoid": { "operationId": "GetHciAlarmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Alarms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Clusters": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Cluster' resource.", "operationId": "GetHciClusterList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Cluster", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.Cluster' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Cluster.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Clusters/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Cluster' resource.", "operationId": "GetHciClusterByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Cluster", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.Cluster' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Cluster" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciClusterByMoid": { "operationId": "GetHciClusterByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Clusters/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "hci" ], "summary": "Update a 'hci.Cluster' resource.", "operationId": "UpdateHciCluster", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.Cluster" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.Cluster' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Cluster" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.Cluster' resource was modified as requested. The 'hci.Cluster' 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/hci.Cluster" } } }, "links": { "GetHciClusterByMoid": { "operationId": "GetHciClusterByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Clusters/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "hci" ], "summary": "Update a 'hci.Cluster' resource.", "operationId": "PatchHciCluster", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.Cluster" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.Cluster' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Cluster" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.Cluster' resource was patched as requested. The 'hci.Cluster' 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/hci.Cluster" } } }, "links": { "GetHciClusterByMoid": { "operationId": "GetHciClusterByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Clusters/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/ClusterOperations": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.ClusterOperation' resource.", "operationId": "GetHciClusterOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.ClusterOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.ClusterOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.ClusterOperation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/ClusterOperations/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.ClusterOperation' resource.", "operationId": "GetHciClusterOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.ClusterOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.ClusterOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.ClusterOperation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciClusterOperationByMoid": { "operationId": "GetHciClusterOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/ClusterOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "hci" ], "summary": "Update a 'hci.ClusterOperation' resource.", "operationId": "UpdateHciClusterOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.ClusterOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.ClusterOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.ClusterOperation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.ClusterOperation' resource was modified as requested. The 'hci.ClusterOperation' 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/hci.ClusterOperation" } } }, "links": { "GetHciClusterOperationByMoid": { "operationId": "GetHciClusterOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/ClusterOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "hci" ], "summary": "Update a 'hci.ClusterOperation' resource.", "operationId": "PatchHciClusterOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.ClusterOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.ClusterOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.ClusterOperation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.ClusterOperation' resource was patched as requested. The 'hci.ClusterOperation' 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/hci.ClusterOperation" } } }, "links": { "GetHciClusterOperationByMoid": { "operationId": "GetHciClusterOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/ClusterOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Compliances": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Compliance' resource.", "operationId": "GetHciComplianceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Compliance", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.Compliance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Compliance.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Compliances/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Compliance' resource.", "operationId": "GetHciComplianceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Compliance", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.Compliance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Compliance" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciComplianceByMoid": { "operationId": "GetHciComplianceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Compliances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Disks": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Disk' resource.", "operationId": "GetHciDiskList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Disk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.Disk' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Disk.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Disks/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Disk' resource.", "operationId": "GetHciDiskByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Disk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.Disk' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Disk" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciDiskByMoid": { "operationId": "GetHciDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Disks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/DomainManagers": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.DomainManager' resource.", "operationId": "GetHciDomainManagerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.DomainManager", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.DomainManager' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.DomainManager.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/DomainManagers/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.DomainManager' resource.", "operationId": "GetHciDomainManagerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.DomainManager", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.DomainManager' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.DomainManager" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciDomainManagerByMoid": { "operationId": "GetHciDomainManagerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/DomainManagers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Entitlements": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Entitlement' resource.", "operationId": "GetHciEntitlementList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Entitlement", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.Entitlement' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Entitlement.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Entitlements/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Entitlement' resource.", "operationId": "GetHciEntitlementByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Entitlement", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.Entitlement' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Entitlement" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciEntitlementByMoid": { "operationId": "GetHciEntitlementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Entitlements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/EsxiVms": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.EsxiVm' resource.", "operationId": "GetHciEsxiVmList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.EsxiVm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.EsxiVm' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.EsxiVm.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/EsxiVms/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.EsxiVm' resource.", "operationId": "GetHciEsxiVmByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.EsxiVm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.EsxiVm' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.EsxiVm" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciEsxiVmByMoid": { "operationId": "GetHciEsxiVmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/EsxiVms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "hci" ], "summary": "Update a 'hci.EsxiVm' resource.", "operationId": "UpdateHciEsxiVm", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.EsxiVm" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.EsxiVm' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.EsxiVm" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.EsxiVm' resource was modified as requested. The 'hci.EsxiVm' 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/hci.EsxiVm" } } }, "links": { "GetHciEsxiVmByMoid": { "operationId": "GetHciEsxiVmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/EsxiVms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "hci" ], "summary": "Update a 'hci.EsxiVm' resource.", "operationId": "PatchHciEsxiVm", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.EsxiVm" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.EsxiVm' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.EsxiVm" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.EsxiVm' resource was patched as requested. The 'hci.EsxiVm' 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/hci.EsxiVm" } } }, "links": { "GetHciEsxiVmByMoid": { "operationId": "GetHciEsxiVmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/EsxiVms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/EsxiVmDisks": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.EsxiVmDisk' resource.", "operationId": "GetHciEsxiVmDiskList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.EsxiVmDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.EsxiVmDisk' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.EsxiVmDisk.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/EsxiVmDisks/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.EsxiVmDisk' resource.", "operationId": "GetHciEsxiVmDiskByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.EsxiVmDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.EsxiVmDisk' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.EsxiVmDisk" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciEsxiVmDiskByMoid": { "operationId": "GetHciEsxiVmDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/EsxiVmDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/EsxiVmNics": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.EsxiVmNic' resource.", "operationId": "GetHciEsxiVmNicList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.EsxiVmNic", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.EsxiVmNic' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.EsxiVmNic.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/EsxiVmNics/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.EsxiVmNic' resource.", "operationId": "GetHciEsxiVmNicByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.EsxiVmNic", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.EsxiVmNic' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.EsxiVmNic" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciEsxiVmNicByMoid": { "operationId": "GetHciEsxiVmNicByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/EsxiVmNics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/ExternalStorages": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.ExternalStorage' resource.", "operationId": "GetHciExternalStorageList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.ExternalStorage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.ExternalStorage' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.ExternalStorage.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/ExternalStorages/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.ExternalStorage' resource.", "operationId": "GetHciExternalStorageByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.ExternalStorage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.ExternalStorage' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.ExternalStorage" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciExternalStorageByMoid": { "operationId": "GetHciExternalStorageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/ExternalStorages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Gpus": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Gpu' resource.", "operationId": "GetHciGpuList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Gpu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.Gpu' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Gpu.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Gpus/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Gpu' resource.", "operationId": "GetHciGpuByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Gpu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.Gpu' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Gpu" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciGpuByMoid": { "operationId": "GetHciGpuByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Gpus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Licenses": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.License' resource.", "operationId": "GetHciLicenseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.License", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.License' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.License.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Licenses/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.License' resource.", "operationId": "GetHciLicenseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.License", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.License' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.License" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciLicenseByMoid": { "operationId": "GetHciLicenseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Licenses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/NccCheckPolicies": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.NccCheckPolicy' resource.", "operationId": "GetHciNccCheckPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.NccCheckPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.NccCheckPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.NccCheckPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/NccCheckPolicies/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.NccCheckPolicy' resource.", "operationId": "GetHciNccCheckPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.NccCheckPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.NccCheckPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.NccCheckPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciNccCheckPolicyByMoid": { "operationId": "GetHciNccCheckPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/NccCheckPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Nodes": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Node' resource.", "operationId": "GetHciNodeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.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 'hci.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/hci.Node.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Nodes/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Node' resource.", "operationId": "GetHciNodeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.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 'hci.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/hci.Node" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciNodeByMoid": { "operationId": "GetHciNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/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": [ "hci" ], "summary": "Update a 'hci.Node' resource.", "operationId": "UpdateHciNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.Node" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.Node' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Node" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.Node' resource was modified as requested. The 'hci.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/hci.Node" } } }, "links": { "GetHciNodeByMoid": { "operationId": "GetHciNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/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": [ "hci" ], "summary": "Update a 'hci.Node' resource.", "operationId": "PatchHciNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "ROLE.Account Administrator", "UPDATE.hci.Node" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'hci.Node' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Node" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hci.Node' resource was patched as requested. The 'hci.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/hci.Node" } } }, "links": { "GetHciNodeByMoid": { "operationId": "GetHciNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/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/hci/PhysicalGpus": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.PhysicalGpu' resource.", "operationId": "GetHciPhysicalGpuList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.PhysicalGpu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.PhysicalGpu' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.PhysicalGpu.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/PhysicalGpus/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.PhysicalGpu' resource.", "operationId": "GetHciPhysicalGpuByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.PhysicalGpu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.PhysicalGpu' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.PhysicalGpu" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciPhysicalGpuByMoid": { "operationId": "GetHciPhysicalGpuByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/PhysicalGpus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/StorageContainers": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.StorageContainer' resource.", "operationId": "GetHciStorageContainerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.StorageContainer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.StorageContainer' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.StorageContainer.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/StorageContainers/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.StorageContainer' resource.", "operationId": "GetHciStorageContainerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.StorageContainer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.StorageContainer' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.StorageContainer" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciStorageContainerByMoid": { "operationId": "GetHciStorageContainerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/StorageContainers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Violations": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Violation' resource.", "operationId": "GetHciViolationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Violation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.Violation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Violation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/Violations/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.Violation' resource.", "operationId": "GetHciViolationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.Violation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.Violation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.Violation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciViolationByMoid": { "operationId": "GetHciViolationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/Violations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/VirtualGpus": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.VirtualGpu' resource.", "operationId": "GetHciVirtualGpuList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.VirtualGpu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hci.VirtualGpu' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.VirtualGpu.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hci/VirtualGpus/{Moid}": { "get": { "tags": [ "hci" ], "summary": "Read a 'hci.VirtualGpu' resource.", "operationId": "GetHciVirtualGpuByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HCI Clusters", "PRIVSET.Read-Only", "PRIVSET.View HCI Clusters", "READ.hci.VirtualGpu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hci.VirtualGpu' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hci.VirtualGpu" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHciVirtualGpuByMoid": { "operationId": "GetHciVirtualGpuByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hci/VirtualGpus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/CompatibilityStatuses": { "post": { "tags": [ "hcl" ], "summary": "Create a 'hcl.CompatibilityStatus' resource.", "operationId": "CreateHclCompatibilityStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.hcl.CompatibilityStatus", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'hcl.CompatibilityStatus' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.CompatibilityStatus" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hcl.CompatibilityStatus' resource was created as requested. The 'hcl.CompatibilityStatus' 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/hcl.CompatibilityStatus" } } }, "links": { "GetHclCompatibilityStatusByMoid": { "operationId": "GetHclCompatibilityStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/CompatibilityStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/DataImportLogs": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.DataImportLog' resource.", "operationId": "GetHclDataImportLogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.hcl.DataImportLog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hcl.DataImportLog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.DataImportLog.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/DataImportLogs/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.DataImportLog' resource.", "operationId": "GetHclDataImportLogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.hcl.DataImportLog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hcl.DataImportLog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.DataImportLog" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclDataImportLogByMoid": { "operationId": "GetHclDataImportLogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/DataImportLogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/DriverImages": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.DriverImage' resource.", "operationId": "GetHclDriverImageList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.hcl.DriverImage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hcl.DriverImage' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.DriverImage.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/DriverImages/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.DriverImage' resource.", "operationId": "GetHclDriverImageByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.hcl.DriverImage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hcl.DriverImage' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.DriverImage" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclDriverImageByMoid": { "operationId": "GetHclDriverImageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/DriverImages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/ExemptedCatalogs": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.ExemptedCatalog' resource.", "operationId": "GetHclExemptedCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.hcl.ExemptedCatalog", "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 'hcl.ExemptedCatalog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.ExemptedCatalog.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/ExemptedCatalogs/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.ExemptedCatalog' resource.", "operationId": "GetHclExemptedCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.hcl.ExemptedCatalog", "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 'hcl.ExemptedCatalog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.ExemptedCatalog" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclExemptedCatalogByMoid": { "operationId": "GetHclExemptedCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/ExemptedCatalogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/HwCatalogInfos": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.HwCatalogInfo' resource.", "operationId": "GetHclHwCatalogInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.hcl.HwCatalogInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hcl.HwCatalogInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.HwCatalogInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/HwCatalogInfos/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.HwCatalogInfo' resource.", "operationId": "GetHclHwCatalogInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.hcl.HwCatalogInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hcl.HwCatalogInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.HwCatalogInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclHwCatalogInfoByMoid": { "operationId": "GetHclHwCatalogInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/HwCatalogInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/HyperflexSoftwareCompatibilityInfos": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.HyperflexSoftwareCompatibilityInfo' resource.", "operationId": "GetHclHyperflexSoftwareCompatibilityInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.hcl.HyperflexSoftwareCompatibilityInfo", "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 'hcl.HyperflexSoftwareCompatibilityInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.HyperflexSoftwareCompatibilityInfo' resource.", "operationId": "GetHclHyperflexSoftwareCompatibilityInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.hcl.HyperflexSoftwareCompatibilityInfo", "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 'hcl.HyperflexSoftwareCompatibilityInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclHyperflexSoftwareCompatibilityInfoByMoid": { "operationId": "GetHclHyperflexSoftwareCompatibilityInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/HyperflexSoftwareCompatibilityInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/OperatingSystems": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.OperatingSystem' resource.", "operationId": "GetHclOperatingSystemList", "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.hcl.OperatingSystem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hcl.OperatingSystem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.OperatingSystem.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/OperatingSystems/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.OperatingSystem' resource.", "operationId": "GetHclOperatingSystemByMoid", "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.hcl.OperatingSystem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hcl.OperatingSystem' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.OperatingSystem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclOperatingSystemByMoid": { "operationId": "GetHclOperatingSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/OperatingSystems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/OperatingSystemVendors": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.OperatingSystemVendor' resource.", "operationId": "GetHclOperatingSystemVendorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS configuration links", "PRIVSET.Add OS image links", "PRIVSET.Delete OS configuration links", "PRIVSET.Delete OS image links", "PRIVSET.Edit OS configuration links", "PRIVSET.Edit OS image links", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.hcl.OperatingSystemVendor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hcl.OperatingSystemVendor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.OperatingSystemVendor.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/OperatingSystemVendors/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.OperatingSystemVendor' resource.", "operationId": "GetHclOperatingSystemVendorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS configuration links", "PRIVSET.Add OS image links", "PRIVSET.Delete OS configuration links", "PRIVSET.Delete OS image links", "PRIVSET.Edit OS configuration links", "PRIVSET.Edit OS image links", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.hcl.OperatingSystemVendor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hcl.OperatingSystemVendor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.OperatingSystemVendor" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclOperatingSystemVendorByMoid": { "operationId": "GetHclOperatingSystemVendorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/OperatingSystemVendors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/ServerCatalogs": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.ServerCatalog' resource.", "operationId": "GetHclServerCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.hcl.ServerCatalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hcl.ServerCatalog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.ServerCatalog.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/ServerCatalogs/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.ServerCatalog' resource.", "operationId": "GetHclServerCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.hcl.ServerCatalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hcl.ServerCatalog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.ServerCatalog" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclServerCatalogByMoid": { "operationId": "GetHclServerCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/ServerCatalogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/ServerHwCatalogInfos": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.ServerHwCatalogInfo' resource.", "operationId": "GetHclServerHwCatalogInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.hcl.ServerHwCatalogInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'hcl.ServerHwCatalogInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.ServerHwCatalogInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/ServerHwCatalogInfos/{Moid}": { "get": { "tags": [ "hcl" ], "summary": "Read a 'hcl.ServerHwCatalogInfo' resource.", "operationId": "GetHclServerHwCatalogInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.hcl.ServerHwCatalogInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'hcl.ServerHwCatalogInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.ServerHwCatalogInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetHclServerHwCatalogInfoByMoid": { "operationId": "GetHclServerHwCatalogInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/ServerHwCatalogInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/hcl/SupportedDriverNames": { "post": { "tags": [ "hcl" ], "summary": "Create a 'hcl.SupportedDriverName' resource.", "operationId": "CreateHclSupportedDriverName", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.hcl.SupportedDriverName", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'hcl.SupportedDriverName' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hcl.SupportedDriverName" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'hcl.SupportedDriverName' resource was created as requested. The 'hcl.SupportedDriverName' 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/hcl.SupportedDriverName" } } }, "links": { "GetHclSupportedDriverNameByMoid": { "operationId": "GetHclSupportedDriverNameByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/hcl/SupportedDriverNames/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Accounts": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Account' resource.", "operationId": "GetIamAccountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.Account' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.Account' resource.", "operationId": "CreateIamAccount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Account' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Account' resource was created as requested. The 'iam.Account' 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/iam.Account" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Accounts/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Account' resource.", "operationId": "GetIamAccountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.Account' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.Account' resource.", "operationId": "UpdateIamAccount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator", "UPDATE.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Account' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Account' resource was modified as requested. The 'iam.Account' 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/iam.Account" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.Account' resource.", "operationId": "PatchIamAccount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "ROLE.Account Administrator", "UPDATE.iam.Account" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Account' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Account" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Account' resource was patched as requested. The 'iam.Account' 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/iam.Account" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.Account' resource.", "operationId": "DeleteIamAccount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Account" ] } ], "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/iam/AccountExperiences": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.AccountExperience' resource.", "operationId": "GetIamAccountExperienceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.iam.AccountExperience" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.AccountExperience' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AccountExperience.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/AccountExperiences/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.AccountExperience' resource.", "operationId": "GetIamAccountExperienceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.iam.AccountExperience" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.AccountExperience' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AccountExperience" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamAccountExperienceByMoid": { "operationId": "GetIamAccountExperienceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AccountExperiences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ApiKeys": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ApiKey' resource.", "operationId": "GetIamApiKeyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Delete API keys", "PRIVSET.Edit API keys", "PRIVSET.Enable and disable API keys", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read all API keys in the account", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iam.ApiKey", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.ApiKey' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.ApiKey' resource.", "operationId": "CreateIamApiKey", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.ApiKey", "PRIVSET.Account Administrator", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.ApiKey' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ApiKey' resource was created as requested. The 'iam.ApiKey' 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/iam.ApiKey" } } }, "links": { "GetIamApiKeyByMoid": { "operationId": "GetIamApiKeyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ApiKeys/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ApiKeys/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ApiKey' resource.", "operationId": "GetIamApiKeyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Delete API keys", "PRIVSET.Edit API keys", "PRIVSET.Enable and disable API keys", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read all API keys in the account", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iam.ApiKey", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.ApiKey' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamApiKeyByMoid": { "operationId": "GetIamApiKeyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ApiKeys/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.ApiKey' resource.", "operationId": "DeleteIamApiKey", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.ApiKey", "PRIVSET.Account Administrator", "PRIVSET.Delete API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "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": [ "iam" ], "summary": "Update a 'iam.ApiKey' resource.", "operationId": "UpdateIamApiKey", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer", "UPDATE.iam.ApiKey" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ApiKey' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ApiKey' resource was modified as requested. The 'iam.ApiKey' 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/iam.ApiKey" } } }, "links": { "GetIamApiKeyByMoid": { "operationId": "GetIamApiKeyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ApiKeys/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.ApiKey' resource.", "operationId": "PatchIamApiKey", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit API keys", "PRIVSET.Manage API Keys", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer", "UPDATE.iam.ApiKey" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ApiKey' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ApiKey" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ApiKey' resource was patched as requested. The 'iam.ApiKey' 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/iam.ApiKey" } } }, "links": { "GetIamApiKeyByMoid": { "operationId": "GetIamApiKeyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ApiKeys/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/AppRegistrations": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.AppRegistration' resource.", "operationId": "GetIamAppRegistrationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Enable and disable OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges", "PRIVSET.Read all OAuth apps in the account", "READ.iam.AppRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.AppRegistration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.AppRegistration' resource.", "operationId": "CreateIamAppRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.AppRegistration", "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.AppRegistration' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.AppRegistration' resource was created as requested. The 'iam.AppRegistration' 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/iam.AppRegistration" } } }, "links": { "GetIamAppRegistrationByMoid": { "operationId": "GetIamAppRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AppRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/AppRegistrations/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.AppRegistration' resource.", "operationId": "GetIamAppRegistrationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Enable and disable OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges", "PRIVSET.Read all OAuth apps in the account", "READ.iam.AppRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.AppRegistration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamAppRegistrationByMoid": { "operationId": "GetIamAppRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AppRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.AppRegistration' resource.", "operationId": "DeleteIamAppRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.AppRegistration", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges" ] } ], "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": [ "iam" ], "summary": "Update a 'iam.AppRegistration' resource.", "operationId": "UpdateIamAppRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges", "UPDATE.iam.AppRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.AppRegistration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.AppRegistration' resource was modified as requested. The 'iam.AppRegistration' 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/iam.AppRegistration" } } }, "links": { "GetIamAppRegistrationByMoid": { "operationId": "GetIamAppRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AppRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.AppRegistration' resource.", "operationId": "PatchIamAppRegistration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Global System Privileges", "UPDATE.iam.AppRegistration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.AppRegistration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.AppRegistration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.AppRegistration' resource was patched as requested. The 'iam.AppRegistration' 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/iam.AppRegistration" } } }, "links": { "GetIamAppRegistrationByMoid": { "operationId": "GetIamAppRegistrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/AppRegistrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/BannerMessages": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.BannerMessage' resource.", "operationId": "GetIamBannerMessageList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure banner message", "READ.iam.BannerMessage", "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 'iam.BannerMessage' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/BannerMessages/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.BannerMessage' resource.", "operationId": "GetIamBannerMessageByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure banner message", "READ.iam.BannerMessage", "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 'iam.BannerMessage' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamBannerMessageByMoid": { "operationId": "GetIamBannerMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/BannerMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.BannerMessage' resource.", "operationId": "UpdateIamBannerMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure banner message", "ROLE.Account Administrator", "UPDATE.iam.BannerMessage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.BannerMessage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.BannerMessage' resource was modified as requested. The 'iam.BannerMessage' 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/iam.BannerMessage" } } }, "links": { "GetIamBannerMessageByMoid": { "operationId": "GetIamBannerMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/BannerMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.BannerMessage' resource.", "operationId": "PatchIamBannerMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure banner message", "ROLE.Account Administrator", "UPDATE.iam.BannerMessage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.BannerMessage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.BannerMessage" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.BannerMessage' resource was patched as requested. The 'iam.BannerMessage' 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/iam.BannerMessage" } } }, "links": { "GetIamBannerMessageByMoid": { "operationId": "GetIamBannerMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/BannerMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Certificates": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Certificate' resource.", "operationId": "GetIamCertificateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.Certificate", "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 'iam.Certificate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.Certificate' resource.", "operationId": "CreateIamCertificate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Certificate", "PRIVSET.Account Administrator", "PRIVSET.Apply SSL Certificate", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Certificate' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Certificate' resource was created as requested. The 'iam.Certificate' 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/iam.Certificate" } } }, "links": { "GetIamCertificateByMoid": { "operationId": "GetIamCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Certificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Certificates/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Certificate' resource.", "operationId": "GetIamCertificateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.Certificate", "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 'iam.Certificate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamCertificateByMoid": { "operationId": "GetIamCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Certificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.Certificate' resource.", "operationId": "UpdateIamCertificate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.Certificate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Certificate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Certificate' resource was modified as requested. The 'iam.Certificate' 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/iam.Certificate" } } }, "links": { "GetIamCertificateByMoid": { "operationId": "GetIamCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Certificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.Certificate' resource.", "operationId": "PatchIamCertificate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.Certificate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Certificate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Certificate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Certificate' resource was patched as requested. The 'iam.Certificate' 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/iam.Certificate" } } }, "links": { "GetIamCertificateByMoid": { "operationId": "GetIamCertificateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Certificates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.Certificate' resource.", "operationId": "DeleteIamCertificate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Certificate", "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/iam/CertificateRequests": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.CertificateRequest' resource.", "operationId": "GetIamCertificateRequestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.CertificateRequest", "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 'iam.CertificateRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.CertificateRequest' resource.", "operationId": "CreateIamCertificateRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.CertificateRequest", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.CertificateRequest' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CertificateRequest' resource was created as requested. The 'iam.CertificateRequest' 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/iam.CertificateRequest" } } }, "links": { "GetIamCertificateRequestByMoid": { "operationId": "GetIamCertificateRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CertificateRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/CertificateRequests/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.CertificateRequest' resource.", "operationId": "GetIamCertificateRequestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.CertificateRequest", "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 'iam.CertificateRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamCertificateRequestByMoid": { "operationId": "GetIamCertificateRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CertificateRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.CertificateRequest' resource.", "operationId": "UpdateIamCertificateRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.CertificateRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.CertificateRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CertificateRequest' resource was modified as requested. The 'iam.CertificateRequest' 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/iam.CertificateRequest" } } }, "links": { "GetIamCertificateRequestByMoid": { "operationId": "GetIamCertificateRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CertificateRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.CertificateRequest' resource.", "operationId": "PatchIamCertificateRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.CertificateRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.CertificateRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CertificateRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CertificateRequest' resource was patched as requested. The 'iam.CertificateRequest' 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/iam.CertificateRequest" } } }, "links": { "GetIamCertificateRequestByMoid": { "operationId": "GetIamCertificateRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CertificateRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.CertificateRequest' resource.", "operationId": "DeleteIamCertificateRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.CertificateRequest", "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/iam/CuiIntegrations": { "post": { "tags": [ "iam" ], "summary": "Create a 'iam.CuiIntegration' resource.", "operationId": "CreateIamCuiIntegration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.CuiIntegration", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.CuiIntegration' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CuiIntegration' resource was created as requested. The 'iam.CuiIntegration' 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/iam.CuiIntegration" } } }, "links": { "GetIamCuiIntegrationByMoid": { "operationId": "GetIamCuiIntegrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CuiIntegrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Read a 'iam.CuiIntegration' resource.", "operationId": "GetIamCuiIntegrationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.iam.CuiIntegration", "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 'iam.CuiIntegration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/CuiIntegrations/{Moid}": { "post": { "tags": [ "iam" ], "summary": "Update a 'iam.CuiIntegration' resource.", "operationId": "UpdateIamCuiIntegration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.CuiIntegration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.CuiIntegration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CuiIntegration' resource was modified as requested. The 'iam.CuiIntegration' 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/iam.CuiIntegration" } } }, "links": { "GetIamCuiIntegrationByMoid": { "operationId": "GetIamCuiIntegrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CuiIntegrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.CuiIntegration' resource.", "operationId": "PatchIamCuiIntegration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.CuiIntegration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.CuiIntegration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.CuiIntegration' resource was patched as requested. The 'iam.CuiIntegration' 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/iam.CuiIntegration" } } }, "links": { "GetIamCuiIntegrationByMoid": { "operationId": "GetIamCuiIntegrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CuiIntegrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Read a 'iam.CuiIntegration' resource.", "operationId": "GetIamCuiIntegrationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.iam.CuiIntegration", "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 'iam.CuiIntegration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.CuiIntegration" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamCuiIntegrationByMoid": { "operationId": "GetIamCuiIntegrationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/CuiIntegrations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DefaultAuthentications": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.DefaultAuthentication' resource.", "operationId": "GetIamDefaultAuthenticationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.DefaultAuthentication", "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 'iam.DefaultAuthentication' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DefaultAuthentications/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.DefaultAuthentication' resource.", "operationId": "GetIamDefaultAuthenticationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.DefaultAuthentication", "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 'iam.DefaultAuthentication' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamDefaultAuthenticationByMoid": { "operationId": "GetIamDefaultAuthenticationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DefaultAuthentications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.DefaultAuthentication' resource.", "operationId": "UpdateIamDefaultAuthentication", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.DefaultAuthentication" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.DefaultAuthentication' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DefaultAuthentication' resource was modified as requested. The 'iam.DefaultAuthentication' 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/iam.DefaultAuthentication" } } }, "links": { "GetIamDefaultAuthenticationByMoid": { "operationId": "GetIamDefaultAuthenticationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DefaultAuthentications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.DefaultAuthentication' resource.", "operationId": "PatchIamDefaultAuthentication", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.DefaultAuthentication" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.DefaultAuthentication' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DefaultAuthentication" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DefaultAuthentication' resource was patched as requested. The 'iam.DefaultAuthentication' 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/iam.DefaultAuthentication" } } }, "links": { "GetIamDefaultAuthenticationByMoid": { "operationId": "GetIamDefaultAuthenticationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DefaultAuthentications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DomainGroups": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.DomainGroup' resource.", "operationId": "GetIamDomainGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.DomainGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.DomainGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainGroup.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DomainGroups/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.DomainGroup' resource.", "operationId": "GetIamDomainGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.DomainGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.DomainGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainGroup" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DomainNameInfos": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.DomainNameInfo' resource.", "operationId": "GetIamDomainNameInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add domain names", "PRIVSET.Add identity providers", "PRIVSET.Delete domain names", "PRIVSET.Delete identity providers", "PRIVSET.Edit identity providers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Regenerate domain names", "PRIVSET.Verify domain names", "PRIVSET.View Access and Permissions", "READ.iam.DomainNameInfo", "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 'iam.DomainNameInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.DomainNameInfo' resource.", "operationId": "CreateIamDomainNameInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.DomainNameInfo", "PRIVSET.Account Administrator", "PRIVSET.Add domain names", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.DomainNameInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DomainNameInfo' resource was created as requested. The 'iam.DomainNameInfo' 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/iam.DomainNameInfo" } } }, "links": { "GetIamDomainNameInfoByMoid": { "operationId": "GetIamDomainNameInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainNameInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/DomainNameInfos/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.DomainNameInfo' resource.", "operationId": "GetIamDomainNameInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add domain names", "PRIVSET.Add identity providers", "PRIVSET.Delete domain names", "PRIVSET.Delete identity providers", "PRIVSET.Edit identity providers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Regenerate domain names", "PRIVSET.Verify domain names", "PRIVSET.View Access and Permissions", "READ.iam.DomainNameInfo", "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 'iam.DomainNameInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamDomainNameInfoByMoid": { "operationId": "GetIamDomainNameInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainNameInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.DomainNameInfo' resource.", "operationId": "UpdateIamDomainNameInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.DomainNameInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.DomainNameInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DomainNameInfo' resource was modified as requested. The 'iam.DomainNameInfo' 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/iam.DomainNameInfo" } } }, "links": { "GetIamDomainNameInfoByMoid": { "operationId": "GetIamDomainNameInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainNameInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.DomainNameInfo' resource.", "operationId": "PatchIamDomainNameInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.DomainNameInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.DomainNameInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.DomainNameInfo" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.DomainNameInfo' resource was patched as requested. The 'iam.DomainNameInfo' 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/iam.DomainNameInfo" } } }, "links": { "GetIamDomainNameInfoByMoid": { "operationId": "GetIamDomainNameInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainNameInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.DomainNameInfo' resource.", "operationId": "DeleteIamDomainNameInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.DomainNameInfo", "PRIVSET.Account Administrator", "PRIVSET.Delete domain names", "PRIVSET.Manage Identity Providers", "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/iam/EndPointPrivileges": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointPrivilege' resource.", "operationId": "GetIamEndPointPrivilegeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Read-Only", "PRIVSET.View Access and Permissions", "READ.iam.EndPointPrivilege", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointPrivilege' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointPrivilege.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointPrivileges/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointPrivilege' resource.", "operationId": "GetIamEndPointPrivilegeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Read-Only", "PRIVSET.View Access and Permissions", "READ.iam.EndPointPrivilege", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointPrivilege' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointPrivilege" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointPrivilegeByMoid": { "operationId": "GetIamEndPointPrivilegeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointPrivileges/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointRoles": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointRole' resource.", "operationId": "GetIamEndPointRoleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.Read-only Local User policies", "PRIVSET.View Access and Permissions", "PRIVSET.View Server Profiles", "READ.iam.EndPointRole", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointRole' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointRole.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointRoles/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointRole' resource.", "operationId": "GetIamEndPointRoleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.Read-only Local User policies", "PRIVSET.View Access and Permissions", "PRIVSET.View Server Profiles", "READ.iam.EndPointRole", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointRole' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointRole" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointRoleByMoid": { "operationId": "GetIamEndPointRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUsers": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUser' resource.", "operationId": "GetIamEndPointUserList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUser", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUser' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.EndPointUser' resource.", "operationId": "CreateIamEndPointUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.EndPointUser", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.EndPointUser' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUser' resource was created as requested. The 'iam.EndPointUser' 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/iam.EndPointUser" } } }, "links": { "GetIamEndPointUserByMoid": { "operationId": "GetIamEndPointUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUsers/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUser' resource.", "operationId": "GetIamEndPointUserByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUser", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUser' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserByMoid": { "operationId": "GetIamEndPointUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.EndPointUser' resource.", "operationId": "UpdateIamEndPointUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUser" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUser' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUser' resource was modified as requested. The 'iam.EndPointUser' 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/iam.EndPointUser" } } }, "links": { "GetIamEndPointUserByMoid": { "operationId": "GetIamEndPointUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.EndPointUser' resource.", "operationId": "PatchIamEndPointUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUser" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUser' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUser" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUser' resource was patched as requested. The 'iam.EndPointUser' 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/iam.EndPointUser" } } }, "links": { "GetIamEndPointUserByMoid": { "operationId": "GetIamEndPointUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.EndPointUser' resource.", "operationId": "DeleteIamEndPointUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.EndPointUser", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Delete Local User policies", "PRIVSET.Edit Local User 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/iam/EndPointUserInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserInventory' resource.", "operationId": "GetIamEndPointUserInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserInventory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserInventory' resource.", "operationId": "GetIamEndPointUserInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserInventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserInventoryByMoid": { "operationId": "GetIamEndPointUserInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserPolicies": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserPolicy' resource.", "operationId": "GetIamEndPointUserPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.Read-only UCS domain profile templates", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.iam.EndPointUserPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.EndPointUserPolicy' resource.", "operationId": "CreateIamEndPointUserPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.EndPointUserPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User 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 'iam.EndPointUserPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserPolicy' resource was created as requested. The 'iam.EndPointUserPolicy' 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/iam.EndPointUserPolicy" } } }, "links": { "GetIamEndPointUserPolicyByMoid": { "operationId": "GetIamEndPointUserPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserPolicies/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserPolicy' resource.", "operationId": "GetIamEndPointUserPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.Read-only UCS domain profile templates", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.iam.EndPointUserPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserPolicyByMoid": { "operationId": "GetIamEndPointUserPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.EndPointUserPolicy' resource.", "operationId": "UpdateIamEndPointUserPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUserPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserPolicy' resource was modified as requested. The 'iam.EndPointUserPolicy' 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/iam.EndPointUserPolicy" } } }, "links": { "GetIamEndPointUserPolicyByMoid": { "operationId": "GetIamEndPointUserPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.EndPointUserPolicy' resource.", "operationId": "PatchIamEndPointUserPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUserPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserPolicy' resource was patched as requested. The 'iam.EndPointUserPolicy' 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/iam.EndPointUserPolicy" } } }, "links": { "GetIamEndPointUserPolicyByMoid": { "operationId": "GetIamEndPointUserPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.EndPointUserPolicy' resource.", "operationId": "DeleteIamEndPointUserPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.EndPointUserPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Local User 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/iam/EndPointUserPolicyInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserPolicyInventory' resource.", "operationId": "GetIamEndPointUserPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.Read-only UCS domain profile templates", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.iam.EndPointUserPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserPolicyInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserPolicyInventory' resource.", "operationId": "GetIamEndPointUserPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.Read-only UCS domain profile templates", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.iam.EndPointUserPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserPolicyInventoryByMoid": { "operationId": "GetIamEndPointUserPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserRoles": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserRole' resource.", "operationId": "GetIamEndPointUserRoleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserRole", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserRole' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.EndPointUserRole' resource.", "operationId": "CreateIamEndPointUserRole", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.EndPointUserRole", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserRole' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserRole' resource was created as requested. The 'iam.EndPointUserRole' 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/iam.EndPointUserRole" } } }, "links": { "GetIamEndPointUserRoleByMoid": { "operationId": "GetIamEndPointUserRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserRoles/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserRole' resource.", "operationId": "GetIamEndPointUserRoleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserRole", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserRole' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserRoleByMoid": { "operationId": "GetIamEndPointUserRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.EndPointUserRole' resource.", "operationId": "UpdateIamEndPointUserRole", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUserRole" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserRole' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserRole' resource was modified as requested. The 'iam.EndPointUserRole' 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/iam.EndPointUserRole" } } }, "links": { "GetIamEndPointUserRoleByMoid": { "operationId": "GetIamEndPointUserRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.EndPointUserRole' resource.", "operationId": "PatchIamEndPointUserRole", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Edit Local User policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.iam.EndPointUserRole" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.EndPointUserRole' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRole" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.EndPointUserRole' resource was patched as requested. The 'iam.EndPointUserRole' 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/iam.EndPointUserRole" } } }, "links": { "GetIamEndPointUserRoleByMoid": { "operationId": "GetIamEndPointUserRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.EndPointUserRole' resource.", "operationId": "DeleteIamEndPointUserRole", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.EndPointUserRole", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Local User policies", "PRIVSET.Delete Local User policies", "PRIVSET.Edit Local User 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/iam/EndPointUserRoleInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserRoleInventory' resource.", "operationId": "GetIamEndPointUserRoleInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserRoleInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.EndPointUserRoleInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/EndPointUserRoleInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.EndPointUserRoleInventory' resource.", "operationId": "GetIamEndPointUserRoleInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Local User policies", "PRIVSET.View Server Profiles", "READ.iam.EndPointUserRoleInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.EndPointUserRoleInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamEndPointUserRoleInventoryByMoid": { "operationId": "GetIamEndPointUserRoleInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/EndPointUserRoleInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/GuestAccessSettings": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.GuestAccessSettings' resource.", "operationId": "GetIamGuestAccessSettingsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.GuestAccessSettings", "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 'iam.GuestAccessSettings' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.GuestAccessSettings' resource.", "operationId": "CreateIamGuestAccessSettings", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.GuestAccessSettings", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.GuestAccessSettings' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.GuestAccessSettings' resource was created as requested. The 'iam.GuestAccessSettings' 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/iam.GuestAccessSettings" } } }, "links": { "GetIamGuestAccessSettingsByMoid": { "operationId": "GetIamGuestAccessSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/GuestAccessSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/GuestAccessSettings/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.GuestAccessSettings' resource.", "operationId": "GetIamGuestAccessSettingsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.GuestAccessSettings", "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 'iam.GuestAccessSettings' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamGuestAccessSettingsByMoid": { "operationId": "GetIamGuestAccessSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/GuestAccessSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.GuestAccessSettings' resource.", "operationId": "UpdateIamGuestAccessSettings", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.GuestAccessSettings" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.GuestAccessSettings' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.GuestAccessSettings' resource was modified as requested. The 'iam.GuestAccessSettings' 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/iam.GuestAccessSettings" } } }, "links": { "GetIamGuestAccessSettingsByMoid": { "operationId": "GetIamGuestAccessSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/GuestAccessSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.GuestAccessSettings' resource.", "operationId": "PatchIamGuestAccessSettings", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.GuestAccessSettings" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.GuestAccessSettings' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.GuestAccessSettings" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.GuestAccessSettings' resource was patched as requested. The 'iam.GuestAccessSettings' 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/iam.GuestAccessSettings" } } }, "links": { "GetIamGuestAccessSettingsByMoid": { "operationId": "GetIamGuestAccessSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/GuestAccessSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.GuestAccessSettings' resource.", "operationId": "DeleteIamGuestAccessSettings", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.GuestAccessSettings", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "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/iam/Idps": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Idp' resource.", "operationId": "GetIamIdpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add identity providers", "PRIVSET.Configure account details", "PRIVSET.Delete identity providers", "PRIVSET.Edit identity providers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.Idp", "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 'iam.Idp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.Idp' resource.", "operationId": "CreateIamIdp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Idp", "PRIVSET.Account Administrator", "PRIVSET.Add identity providers", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Idp' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Idp' resource was created as requested. The 'iam.Idp' 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/iam.Idp" } } }, "links": { "GetIamIdpByMoid": { "operationId": "GetIamIdpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Idps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Idps/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Idp' resource.", "operationId": "GetIamIdpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add identity providers", "PRIVSET.Configure account details", "PRIVSET.Delete identity providers", "PRIVSET.Edit identity providers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.Idp", "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 'iam.Idp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamIdpByMoid": { "operationId": "GetIamIdpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Idps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.Idp' resource.", "operationId": "UpdateIamIdp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit identity providers", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.Idp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Idp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Idp' resource was modified as requested. The 'iam.Idp' 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/iam.Idp" } } }, "links": { "GetIamIdpByMoid": { "operationId": "GetIamIdpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Idps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.Idp' resource.", "operationId": "PatchIamIdp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit identity providers", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.Idp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Idp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Idp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Idp' resource was patched as requested. The 'iam.Idp' 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/iam.Idp" } } }, "links": { "GetIamIdpByMoid": { "operationId": "GetIamIdpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Idps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.Idp' resource.", "operationId": "DeleteIamIdp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Idp", "PRIVSET.Account Administrator", "PRIVSET.Delete identity providers", "PRIVSET.Manage Identity Providers", "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/iam/IdpReferences": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IdpReference' resource.", "operationId": "GetIamIdpReferenceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure MFA", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Read-only software repository", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.IdpReference", "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 'iam.IdpReference' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IdpReferences/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IdpReference' resource.", "operationId": "GetIamIdpReferenceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure MFA", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Read-only software repository", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.IdpReference", "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 'iam.IdpReference' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamIdpReferenceByMoid": { "operationId": "GetIamIdpReferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IdpReferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.IdpReference' resource.", "operationId": "UpdateIamIdpReference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.IdpReference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IdpReference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IdpReference' resource was modified as requested. The 'iam.IdpReference' 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/iam.IdpReference" } } }, "links": { "GetIamIdpReferenceByMoid": { "operationId": "GetIamIdpReferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IdpReferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.IdpReference' resource.", "operationId": "PatchIamIdpReference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator", "UPDATE.iam.IdpReference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IdpReference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IdpReference" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IdpReference' resource was patched as requested. The 'iam.IdpReference' 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/iam.IdpReference" } } }, "links": { "GetIamIdpReferenceByMoid": { "operationId": "GetIamIdpReferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IdpReferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IpAccessManagements": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IpAccessManagement' resource.", "operationId": "GetIamIpAccessManagementList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Enable/disable IP access management", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.IpAccessManagement", "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 'iam.IpAccessManagement' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.IpAccessManagement' resource.", "operationId": "CreateIamIpAccessManagement", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.IpAccessManagement", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.IpAccessManagement' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAccessManagement' resource was created as requested. The 'iam.IpAccessManagement' 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/iam.IpAccessManagement" } } }, "links": { "GetIamIpAccessManagementByMoid": { "operationId": "GetIamIpAccessManagementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAccessManagements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IpAccessManagements/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IpAccessManagement' resource.", "operationId": "GetIamIpAccessManagementByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Enable/disable IP access management", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.IpAccessManagement", "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 'iam.IpAccessManagement' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamIpAccessManagementByMoid": { "operationId": "GetIamIpAccessManagementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAccessManagements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.IpAccessManagement' resource.", "operationId": "UpdateIamIpAccessManagement", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.IpAccessManagement" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IpAccessManagement' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAccessManagement' resource was modified as requested. The 'iam.IpAccessManagement' 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/iam.IpAccessManagement" } } }, "links": { "GetIamIpAccessManagementByMoid": { "operationId": "GetIamIpAccessManagementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAccessManagements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.IpAccessManagement' resource.", "operationId": "PatchIamIpAccessManagement", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.IpAccessManagement" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IpAccessManagement' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAccessManagement" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAccessManagement' resource was patched as requested. The 'iam.IpAccessManagement' 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/iam.IpAccessManagement" } } }, "links": { "GetIamIpAccessManagementByMoid": { "operationId": "GetIamIpAccessManagementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/IpAccessManagements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/IpAddresses": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IpAddress' resource.", "operationId": "GetIamIpAddressList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Enable/disable IP access management", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.IpAddress", "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 'iam.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/iam.IpAddress.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.IpAddress' resource.", "operationId": "CreateIamIpAddress", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.IpAddress", "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.IpAddress' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAddress' resource was created as requested. The 'iam.IpAddress' 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/iam.IpAddress" } } }, "links": { "GetIamIpAddressByMoid": { "operationId": "GetIamIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/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/iam/IpAddresses/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.IpAddress' resource.", "operationId": "GetIamIpAddressByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted IP ranges", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Enable/disable IP access management", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "READ.iam.IpAddress", "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 'iam.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/iam.IpAddress" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamIpAddressByMoid": { "operationId": "GetIamIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/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" } } }, "post": { "tags": [ "iam" ], "summary": "Update a 'iam.IpAddress' resource.", "operationId": "UpdateIamIpAddress", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.IpAddress" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IpAddress' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAddress' resource was modified as requested. The 'iam.IpAddress' 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/iam.IpAddress" } } }, "links": { "GetIamIpAddressByMoid": { "operationId": "GetIamIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/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" } } }, "patch": { "tags": [ "iam" ], "summary": "Update a 'iam.IpAddress' resource.", "operationId": "PatchIamIpAddress", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit trusted IP ranges", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.IpAddress" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.IpAddress' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.IpAddress" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.IpAddress' resource was patched as requested. The 'iam.IpAddress' 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/iam.IpAddress" } } }, "links": { "GetIamIpAddressByMoid": { "operationId": "GetIamIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/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" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.IpAddress' resource.", "operationId": "DeleteIamIpAddress", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.IpAddress", "PRIVSET.Account Administrator", "PRIVSET.Delete trusted IP ranges", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "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/iam/LdapConfigParams": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapConfigParams' resource.", "operationId": "GetIamLdapConfigParamsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "READ.iam.LdapConfigParams", "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 'iam.LdapConfigParams' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapConfigParams.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapConfigParams/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapConfigParams' resource.", "operationId": "GetIamLdapConfigParamsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "READ.iam.LdapConfigParams", "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 'iam.LdapConfigParams' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapConfigParams" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapConfigParamsByMoid": { "operationId": "GetIamLdapConfigParamsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapConfigParams/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapGroups": { "post": { "tags": [ "iam" ], "summary": "Create a 'iam.LdapGroup' resource.", "operationId": "CreateIamLdapGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.LdapGroup", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.LdapGroup' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapGroup' resource was created as requested. The 'iam.LdapGroup' 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/iam.LdapGroup" } } }, "links": { "GetIamLdapGroupByMoid": { "operationId": "GetIamLdapGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Read a 'iam.LdapGroup' resource.", "operationId": "GetIamLdapGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapGroups/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapGroup' resource.", "operationId": "GetIamLdapGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapGroupByMoid": { "operationId": "GetIamLdapGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LdapGroup' resource.", "operationId": "UpdateIamLdapGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapGroup' resource was modified as requested. The 'iam.LdapGroup' 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/iam.LdapGroup" } } }, "links": { "GetIamLdapGroupByMoid": { "operationId": "GetIamLdapGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LdapGroup' resource.", "operationId": "PatchIamLdapGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroup" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapGroup' resource was patched as requested. The 'iam.LdapGroup' 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/iam.LdapGroup" } } }, "links": { "GetIamLdapGroupByMoid": { "operationId": "GetIamLdapGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.LdapGroup' resource.", "operationId": "DeleteIamLdapGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.LdapGroup", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Delete LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "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/iam/LdapGroupInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapGroupInventory' resource.", "operationId": "GetIamLdapGroupInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapGroupInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapGroupInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroupInventory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapGroupInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapGroupInventory' resource.", "operationId": "GetIamLdapGroupInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapGroupInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapGroupInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapGroupInventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapGroupInventoryByMoid": { "operationId": "GetIamLdapGroupInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapGroupInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapMeta": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapMeta' resource.", "operationId": "GetIamLdapMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.LdapMeta", "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 'iam.LdapMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapMeta.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapMeta/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapMeta' resource.", "operationId": "GetIamLdapMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.LdapMeta", "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 'iam.LdapMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapMeta" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapMetaByMoid": { "operationId": "GetIamLdapMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapPolicies": { "post": { "tags": [ "iam" ], "summary": "Create a 'iam.LdapPolicy' resource.", "operationId": "CreateIamLdapPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.LdapPolicy", "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.LdapPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapPolicy' resource was created as requested. The 'iam.LdapPolicy' 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/iam.LdapPolicy" } } }, "links": { "GetIamLdapPolicyByMoid": { "operationId": "GetIamLdapPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Read a 'iam.LdapPolicy' resource.", "operationId": "GetIamLdapPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapPolicies/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapPolicy' resource.", "operationId": "GetIamLdapPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapPolicyByMoid": { "operationId": "GetIamLdapPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LdapPolicy' resource.", "operationId": "UpdateIamLdapPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit LDAP policies", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapPolicy' resource was modified as requested. The 'iam.LdapPolicy' 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/iam.LdapPolicy" } } }, "links": { "GetIamLdapPolicyByMoid": { "operationId": "GetIamLdapPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LdapPolicy' resource.", "operationId": "PatchIamLdapPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit LDAP policies", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapPolicy' resource was patched as requested. The 'iam.LdapPolicy' 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/iam.LdapPolicy" } } }, "links": { "GetIamLdapPolicyByMoid": { "operationId": "GetIamLdapPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.LdapPolicy' resource.", "operationId": "DeleteIamLdapPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.LdapPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete LDAP policies", "PRIVSET.Delete LDAP servers", "PRIVSET.Manage Access and Permissions", "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/iam/LdapPolicyInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapPolicyInventory' resource.", "operationId": "GetIamLdapPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapPolicyInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapPolicyInventory' resource.", "operationId": "GetIamLdapPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapPolicyInventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapPolicyInventoryByMoid": { "operationId": "GetIamLdapPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapProviders": { "post": { "tags": [ "iam" ], "summary": "Create a 'iam.LdapProvider' resource.", "operationId": "CreateIamLdapProvider", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.LdapProvider", "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.LdapProvider' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapProvider' resource was created as requested. The 'iam.LdapProvider' 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/iam.LdapProvider" } } }, "links": { "GetIamLdapProviderByMoid": { "operationId": "GetIamLdapProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Read a 'iam.LdapProvider' resource.", "operationId": "GetIamLdapProviderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapProvider", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapProvider' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapProviders/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapProvider' resource.", "operationId": "GetIamLdapProviderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapProvider", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapProvider' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapProviderByMoid": { "operationId": "GetIamLdapProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LdapProvider' resource.", "operationId": "UpdateIamLdapProvider", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapProvider" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapProvider' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapProvider' resource was modified as requested. The 'iam.LdapProvider' 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/iam.LdapProvider" } } }, "links": { "GetIamLdapProviderByMoid": { "operationId": "GetIamLdapProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LdapProvider' resource.", "operationId": "PatchIamLdapProvider", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Edit LDAP policies", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.iam.LdapProvider" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LdapProvider' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProvider" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LdapProvider' resource was patched as requested. The 'iam.LdapProvider' 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/iam.LdapProvider" } } }, "links": { "GetIamLdapProviderByMoid": { "operationId": "GetIamLdapProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.LdapProvider' resource.", "operationId": "DeleteIamLdapProvider", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.LdapProvider", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LDAP policies", "PRIVSET.Delete LDAP policies", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP policies", "PRIVSET.Manage Access and Permissions", "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/iam/LdapProviderInventories": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapProviderInventory' resource.", "operationId": "GetIamLdapProviderInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapProviderInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LdapProviderInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProviderInventory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LdapProviderInventories/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LdapProviderInventory' resource.", "operationId": "GetIamLdapProviderInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LDAP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iam.LdapProviderInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LdapProviderInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LdapProviderInventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLdapProviderInventoryByMoid": { "operationId": "GetIamLdapProviderInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LdapProviderInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LocalUserPasswords": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LocalUserPassword' resource.", "operationId": "GetIamLocalUserPasswordList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.LocalUserPassword" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.LocalUserPassword' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.LocalUserPassword' resource.", "operationId": "CreateIamLocalUserPassword", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.LocalUserPassword", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPassword' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPassword' resource was created as requested. The 'iam.LocalUserPassword' 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/iam.LocalUserPassword" } } }, "links": { "GetIamLocalUserPasswordByMoid": { "operationId": "GetIamLocalUserPasswordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LocalUserPasswords/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LocalUserPassword' resource.", "operationId": "GetIamLocalUserPasswordByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.LocalUserPassword" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.LocalUserPassword' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLocalUserPasswordByMoid": { "operationId": "GetIamLocalUserPasswordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LocalUserPassword' resource.", "operationId": "UpdateIamLocalUserPassword", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.LocalUserPassword" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPassword' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPassword' resource was modified as requested. The 'iam.LocalUserPassword' 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/iam.LocalUserPassword" } } }, "links": { "GetIamLocalUserPasswordByMoid": { "operationId": "GetIamLocalUserPasswordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LocalUserPassword' resource.", "operationId": "PatchIamLocalUserPassword", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.LocalUserPassword" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPassword' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPassword" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPassword' resource was patched as requested. The 'iam.LocalUserPassword' 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/iam.LocalUserPassword" } } }, "links": { "GetIamLocalUserPasswordByMoid": { "operationId": "GetIamLocalUserPasswordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LocalUserPasswordPolicies": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LocalUserPasswordPolicy' resource.", "operationId": "GetIamLocalUserPasswordPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Local Users Password Policy", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.LocalUserPasswordPolicy", "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 'iam.LocalUserPasswordPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/LocalUserPasswordPolicies/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.LocalUserPasswordPolicy' resource.", "operationId": "GetIamLocalUserPasswordPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Local Users Password Policy", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.LocalUserPasswordPolicy", "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 'iam.LocalUserPasswordPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamLocalUserPasswordPolicyByMoid": { "operationId": "GetIamLocalUserPasswordPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswordPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LocalUserPasswordPolicy' resource.", "operationId": "UpdateIamLocalUserPasswordPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Local Users Password Policy", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.LocalUserPasswordPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPasswordPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPasswordPolicy' resource was modified as requested. The 'iam.LocalUserPasswordPolicy' 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/iam.LocalUserPasswordPolicy" } } }, "links": { "GetIamLocalUserPasswordPolicyByMoid": { "operationId": "GetIamLocalUserPasswordPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswordPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.LocalUserPasswordPolicy' resource.", "operationId": "PatchIamLocalUserPasswordPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Local Users Password Policy", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.LocalUserPasswordPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.LocalUserPasswordPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.LocalUserPasswordPolicy' resource was patched as requested. The 'iam.LocalUserPasswordPolicy' 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/iam.LocalUserPasswordPolicy" } } }, "links": { "GetIamLocalUserPasswordPolicyByMoid": { "operationId": "GetIamLocalUserPasswordPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/LocalUserPasswordPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/OAuthTokens": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.OAuthToken' resource.", "operationId": "GetIamOAuthTokenList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Delete OAuth 2.0 tokens", "PRIVSET.Manage Auth Tokens", "PRIVSET.Read-Only", "READ.iam.OAuthToken", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.OAuthToken' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.OAuthToken.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/OAuthTokens/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.OAuthToken' resource.", "operationId": "GetIamOAuthTokenByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Delete OAuth 2.0 tokens", "PRIVSET.Manage Auth Tokens", "PRIVSET.Read-Only", "READ.iam.OAuthToken", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.OAuthToken' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.OAuthToken" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamOAuthTokenByMoid": { "operationId": "GetIamOAuthTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/OAuthTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.OAuthToken' resource.", "operationId": "DeleteIamOAuthToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.OAuthToken", "PRIVSET.Account Administrator", "PRIVSET.Delete OAuth 2.0 tokens", "PRIVSET.Manage Auth Tokens", "PRIVSET.Read-Only", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "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/iam/PasswordHistorySettingCollections": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PasswordHistorySettingCollection' resource.", "operationId": "GetIamPasswordHistorySettingCollectionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.iam.PasswordHistorySettingCollection", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.PasswordHistorySettingCollection' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PasswordHistorySettingCollection.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PasswordHistorySettingCollections/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PasswordHistorySettingCollection' resource.", "operationId": "GetIamPasswordHistorySettingCollectionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.iam.PasswordHistorySettingCollection", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.PasswordHistorySettingCollection' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PasswordHistorySettingCollection" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamPasswordHistorySettingCollectionByMoid": { "operationId": "GetIamPasswordHistorySettingCollectionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PasswordHistorySettingCollections/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Permissions": { "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Create a 'iam.Permission' resource.", "operationId": "CreateIamPermission", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Permission", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Permission' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Permission' resource was created as requested. The 'iam.Permission' 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/iam.Permission" } } }, "links": { "GetIamPermissionByMoid": { "operationId": "GetIamPermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Permissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Permission' resource.", "operationId": "GetIamPermissionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Permission", "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 'iam.Permission' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Permissions/{Moid}": { "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.Permission' resource.", "operationId": "UpdateIamPermission", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.Permission" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Permission' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Permission' resource was modified as requested. The 'iam.Permission' 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/iam.Permission" } } }, "links": { "GetIamPermissionByMoid": { "operationId": "GetIamPermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Permissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.Permission' resource.", "operationId": "PatchIamPermission", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.Permission" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Permission' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Permission' resource was patched as requested. The 'iam.Permission' 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/iam.Permission" } } }, "links": { "GetIamPermissionByMoid": { "operationId": "GetIamPermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Permissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Delete a 'iam.Permission' resource.", "operationId": "DeleteIamPermission", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Permission", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "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" } } }, "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Permission' resource.", "operationId": "GetIamPermissionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Permission", "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 'iam.Permission' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Permission" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamPermissionByMoid": { "operationId": "GetIamPermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Permissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivateKeySpecs": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PrivateKeySpec' resource.", "operationId": "GetIamPrivateKeySpecList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.PrivateKeySpec", "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 'iam.PrivateKeySpec' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.PrivateKeySpec' resource.", "operationId": "CreateIamPrivateKeySpec", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.PrivateKeySpec", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.PrivateKeySpec' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivateKeySpec' resource was created as requested. The 'iam.PrivateKeySpec' 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/iam.PrivateKeySpec" } } }, "links": { "GetIamPrivateKeySpecByMoid": { "operationId": "GetIamPrivateKeySpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivateKeySpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivateKeySpecs/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PrivateKeySpec' resource.", "operationId": "GetIamPrivateKeySpecByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only SSL Certificates", "READ.iam.PrivateKeySpec", "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 'iam.PrivateKeySpec' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamPrivateKeySpecByMoid": { "operationId": "GetIamPrivateKeySpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivateKeySpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.PrivateKeySpec' resource.", "operationId": "UpdateIamPrivateKeySpec", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.PrivateKeySpec" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.PrivateKeySpec' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivateKeySpec' resource was modified as requested. The 'iam.PrivateKeySpec' 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/iam.PrivateKeySpec" } } }, "links": { "GetIamPrivateKeySpecByMoid": { "operationId": "GetIamPrivateKeySpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivateKeySpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.PrivateKeySpec' resource.", "operationId": "PatchIamPrivateKeySpec", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iam.PrivateKeySpec" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.PrivateKeySpec' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivateKeySpec" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivateKeySpec' resource was patched as requested. The 'iam.PrivateKeySpec' 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/iam.PrivateKeySpec" } } }, "links": { "GetIamPrivateKeySpecByMoid": { "operationId": "GetIamPrivateKeySpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivateKeySpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.PrivateKeySpec' resource.", "operationId": "DeleteIamPrivateKeySpec", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.PrivateKeySpec", "PRIVSET.Account Administrator", "PRIVSET.Delete CSR", "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/iam/Privileges": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Privilege' resource.", "operationId": "GetIamPrivilegeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Privilege", "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 'iam.Privilege' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Privilege.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Privileges/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Privilege' resource.", "operationId": "GetIamPrivilegeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Privilege", "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 'iam.Privilege' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Privilege" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamPrivilegeByMoid": { "operationId": "GetIamPrivilegeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Privileges/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivilegeSets": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.PrivilegeSet' resource.", "operationId": "GetIamPrivilegeSetList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.User Access Administrator", "PRIVSET.View Access and Permissions", "READ.iam.PrivilegeSet", "ROLE.Account Administrator", "ROLE.User Access 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 'iam.PrivilegeSet' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Create a 'iam.PrivilegeSet' resource.", "operationId": "CreateIamPrivilegeSet", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.PrivilegeSet", "PRIVSET.Account Administrator", "PRIVSET.User Access Administrator", "ROLE.Account Administrator", "ROLE.User Access Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.PrivilegeSet' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivilegeSet' resource was created as requested. The 'iam.PrivilegeSet' 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/iam.PrivilegeSet" } } }, "links": { "GetIamPrivilegeSetByMoid": { "operationId": "GetIamPrivilegeSetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivilegeSets/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.PrivilegeSet' resource.", "operationId": "GetIamPrivilegeSetByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.User Access Administrator", "PRIVSET.View Access and Permissions", "READ.iam.PrivilegeSet", "ROLE.Account Administrator", "ROLE.User Access 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 'iam.PrivilegeSet' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamPrivilegeSetByMoid": { "operationId": "GetIamPrivilegeSetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.PrivilegeSet' resource.", "operationId": "UpdateIamPrivilegeSet", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.User Access Administrator", "ROLE.Account Administrator", "ROLE.User Access Administrator", "UPDATE.iam.PrivilegeSet" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.PrivilegeSet' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivilegeSet' resource was modified as requested. The 'iam.PrivilegeSet' 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/iam.PrivilegeSet" } } }, "links": { "GetIamPrivilegeSetByMoid": { "operationId": "GetIamPrivilegeSetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.PrivilegeSet' resource.", "operationId": "PatchIamPrivilegeSet", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.User Access Administrator", "ROLE.Account Administrator", "ROLE.User Access Administrator", "UPDATE.iam.PrivilegeSet" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.PrivilegeSet' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSet" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivilegeSet' resource was patched as requested. The 'iam.PrivilegeSet' 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/iam.PrivilegeSet" } } }, "links": { "GetIamPrivilegeSetByMoid": { "operationId": "GetIamPrivilegeSetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Delete a 'iam.PrivilegeSet' resource.", "operationId": "DeleteIamPrivilegeSet", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.PrivilegeSet", "PRIVSET.Account Administrator", "PRIVSET.User Access Administrator", "ROLE.Account Administrator", "ROLE.User Access 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/iam/PrivilegeSetMetaInfos": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PrivilegeSetMetaInfo' resource.", "operationId": "GetIamPrivilegeSetMetaInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.PrivilegeSetMetaInfo", "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 'iam.PrivilegeSetMetaInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.PrivilegeSetMetaInfo' resource.", "operationId": "CreateIamPrivilegeSetMetaInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.PrivilegeSetMetaInfo", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.PrivilegeSetMetaInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.PrivilegeSetMetaInfo' resource was created as requested. The 'iam.PrivilegeSetMetaInfo' 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/iam.PrivilegeSetMetaInfo" } } }, "links": { "GetIamPrivilegeSetMetaInfoByMoid": { "operationId": "GetIamPrivilegeSetMetaInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSetMetaInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/PrivilegeSetMetaInfos/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.PrivilegeSetMetaInfo' resource.", "operationId": "GetIamPrivilegeSetMetaInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.PrivilegeSetMetaInfo", "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 'iam.PrivilegeSetMetaInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamPrivilegeSetMetaInfoByMoid": { "operationId": "GetIamPrivilegeSetMetaInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/PrivilegeSetMetaInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Qualifiers": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Qualifier' resource.", "operationId": "GetIamQualifierList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Qualifier", "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 'iam.Qualifier' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.Qualifier' resource.", "operationId": "CreateIamQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.Qualifier", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.Qualifier' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Qualifier' resource was created as requested. The 'iam.Qualifier' 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/iam.Qualifier" } } }, "links": { "GetIamQualifierByMoid": { "operationId": "GetIamQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Qualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Qualifiers/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Qualifier' resource.", "operationId": "GetIamQualifierByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Qualifier", "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 'iam.Qualifier' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamQualifierByMoid": { "operationId": "GetIamQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Qualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.Qualifier' resource.", "operationId": "UpdateIamQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.Qualifier" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Qualifier' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Qualifier' resource was modified as requested. The 'iam.Qualifier' 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/iam.Qualifier" } } }, "links": { "GetIamQualifierByMoid": { "operationId": "GetIamQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Qualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.Qualifier' resource.", "operationId": "PatchIamQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.Qualifier" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.Qualifier' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Qualifier" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.Qualifier' resource was patched as requested. The 'iam.Qualifier' 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/iam.Qualifier" } } }, "links": { "GetIamQualifierByMoid": { "operationId": "GetIamQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Qualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.Qualifier' resource.", "operationId": "DeleteIamQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Qualifier", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "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/iam/ResourceLimits": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ResourceLimits' resource.", "operationId": "GetIamResourceLimitsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Delete API keys", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Edit API keys", "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Enable and disable API keys", "PRIVSET.Enable and disable OAuth 2.0 grant type applications", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Manage Auth Tokens", "PRIVSET.Manage Sessions", "PRIVSET.Read-Only", "PRIVSET.View Access and Permissions", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iam.ResourceLimits", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.ResourceLimits' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourceLimits/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ResourceLimits' resource.", "operationId": "GetIamResourceLimitsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Create OAuth 2.0 grant type applications", "PRIVSET.Delete API keys", "PRIVSET.Delete OAuth 2.0 grant type applications", "PRIVSET.Edit API keys", "PRIVSET.Edit OAuth 2.0 grant type applications", "PRIVSET.Enable and disable API keys", "PRIVSET.Enable and disable OAuth 2.0 grant type applications", "PRIVSET.Generate API keys", "PRIVSET.Manage API Keys", "PRIVSET.Manage Auth Tokens", "PRIVSET.Manage Sessions", "PRIVSET.Read-Only", "PRIVSET.View Access and Permissions", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iam.ResourceLimits", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.ResourceLimits' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamResourceLimitsByMoid": { "operationId": "GetIamResourceLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.ResourceLimits' resource.", "operationId": "UpdateIamResourceLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.ResourceLimits" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ResourceLimits' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceLimits' resource was modified as requested. The 'iam.ResourceLimits' 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/iam.ResourceLimits" } } }, "links": { "GetIamResourceLimitsByMoid": { "operationId": "GetIamResourceLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.ResourceLimits' resource.", "operationId": "PatchIamResourceLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.ResourceLimits" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ResourceLimits' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceLimits" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceLimits' resource was patched as requested. The 'iam.ResourceLimits' 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/iam.ResourceLimits" } } }, "links": { "GetIamResourceLimitsByMoid": { "operationId": "GetIamResourceLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourcePermissions": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.ResourcePermission' resource.", "operationId": "GetIamResourcePermissionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.ResourcePermission" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.ResourcePermission' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourcePermission.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourcePermissions/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.ResourcePermission' resource.", "operationId": "GetIamResourcePermissionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.ResourcePermission" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.ResourcePermission' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourcePermission" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamResourcePermissionByMoid": { "operationId": "GetIamResourcePermissionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourcePermissions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourceRoles": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ResourceRoles' resource.", "operationId": "GetIamResourceRolesList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.ResourceRoles", "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 'iam.ResourceRoles' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.ResourceRoles' resource.", "operationId": "CreateIamResourceRoles", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.ResourceRoles", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.ResourceRoles' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceRoles' resource was created as requested. The 'iam.ResourceRoles' 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/iam.ResourceRoles" } } }, "links": { "GetIamResourceRolesByMoid": { "operationId": "GetIamResourceRolesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ResourceRoles/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ResourceRoles' resource.", "operationId": "GetIamResourceRolesByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.ResourceRoles", "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 'iam.ResourceRoles' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamResourceRolesByMoid": { "operationId": "GetIamResourceRolesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.ResourceRoles' resource.", "operationId": "UpdateIamResourceRoles", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.ResourceRoles" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ResourceRoles' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceRoles' resource was modified as requested. The 'iam.ResourceRoles' 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/iam.ResourceRoles" } } }, "links": { "GetIamResourceRolesByMoid": { "operationId": "GetIamResourceRolesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.ResourceRoles' resource.", "operationId": "PatchIamResourceRoles", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.ResourceRoles" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.ResourceRoles' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ResourceRoles" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.ResourceRoles' resource was patched as requested. The 'iam.ResourceRoles' 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/iam.ResourceRoles" } } }, "links": { "GetIamResourceRolesByMoid": { "operationId": "GetIamResourceRolesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ResourceRoles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.ResourceRoles' resource.", "operationId": "DeleteIamResourceRoles", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.ResourceRoles", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "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/iam/Roles": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Role' resource.", "operationId": "GetIamRoleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Role", "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 'iam.Role' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Role.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Roles/{Moid}": { "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.Role' resource.", "operationId": "GetIamRoleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.Role", "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 'iam.Role' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.Role" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamRoleByMoid": { "operationId": "GetIamRoleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Roles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SecurityHolders": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.SecurityHolder' resource.", "operationId": "GetIamSecurityHolderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.SecurityHolder", "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 'iam.SecurityHolder' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SecurityHolder.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SecurityHolders/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.SecurityHolder' resource.", "operationId": "GetIamSecurityHolderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.SecurityHolder", "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 'iam.SecurityHolder' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SecurityHolder" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamSecurityHolderByMoid": { "operationId": "GetIamSecurityHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SecurityHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ServiceProviders": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ServiceProvider' resource.", "operationId": "GetIamServiceProviderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "READ.iam.ServiceProvider", "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 'iam.ServiceProvider' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ServiceProvider.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/ServiceProviders/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.ServiceProvider' resource.", "operationId": "GetIamServiceProviderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Identity Providers", "READ.iam.ServiceProvider", "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 'iam.ServiceProvider' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.ServiceProvider" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamServiceProviderByMoid": { "operationId": "GetIamServiceProviderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/ServiceProviders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Sessions": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Session' resource.", "operationId": "GetIamSessionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.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 'iam.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/iam.Session.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Sessions/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.Session' resource.", "operationId": "GetIamSessionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.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 'iam.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/iam.Session" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamSessionByMoid": { "operationId": "GetIamSessionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/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" } } }, "delete": { "tags": [ "iam" ], "summary": "Delete a 'iam.Session' resource.", "operationId": "DeleteIamSession", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.Session", "PRIVSET.Account Administrator", "PRIVSET.Manage Sessions", "PRIVSET.Terminate sessions", "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/iam/SessionLimits": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.SessionLimits' resource.", "operationId": "GetIamSessionLimitsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.SessionLimits", "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 'iam.SessionLimits' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.SessionLimits' resource.", "operationId": "CreateIamSessionLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.SessionLimits", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.SessionLimits' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SessionLimits' resource was created as requested. The 'iam.SessionLimits' 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/iam.SessionLimits" } } }, "links": { "GetIamSessionLimitsByMoid": { "operationId": "GetIamSessionLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SessionLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SessionLimits/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.SessionLimits' resource.", "operationId": "GetIamSessionLimitsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Sessions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.SessionLimits", "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 'iam.SessionLimits' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamSessionLimitsByMoid": { "operationId": "GetIamSessionLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SessionLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.SessionLimits' resource.", "operationId": "UpdateIamSessionLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.SessionLimits" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.SessionLimits' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SessionLimits' resource was modified as requested. The 'iam.SessionLimits' 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/iam.SessionLimits" } } }, "links": { "GetIamSessionLimitsByMoid": { "operationId": "GetIamSessionLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SessionLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.SessionLimits' resource.", "operationId": "PatchIamSessionLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure account details", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "ROLE.Account Administrator", "UPDATE.iam.SessionLimits" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.SessionLimits' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SessionLimits" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SessionLimits' resource was patched as requested. The 'iam.SessionLimits' 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/iam.SessionLimits" } } }, "links": { "GetIamSessionLimitsByMoid": { "operationId": "GetIamSessionLimitsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SessionLimits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.SessionLimits' resource.", "operationId": "DeleteIamSessionLimits", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.SessionLimits", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Sessions", "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/iam/SharingRules": { "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Create a 'iam.SharingRule' resource.", "operationId": "CreateIamSharingRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.SharingRule", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.SharingRule' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SharingRule' resource was created as requested. The 'iam.SharingRule' 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/iam.SharingRule" } } }, "links": { "GetIamSharingRuleByMoid": { "operationId": "GetIamSharingRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SharingRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.SharingRule' resource.", "operationId": "GetIamSharingRuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.iam.SharingRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.SharingRule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/SharingRules/{Moid}": { "post": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.SharingRule' resource.", "operationId": "UpdateIamSharingRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.iam.SharingRule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.SharingRule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SharingRule' resource was modified as requested. The 'iam.SharingRule' 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/iam.SharingRule" } } }, "links": { "GetIamSharingRuleByMoid": { "operationId": "GetIamSharingRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SharingRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Update a 'iam.SharingRule' resource.", "operationId": "PatchIamSharingRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.iam.SharingRule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.SharingRule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.SharingRule' resource was patched as requested. The 'iam.SharingRule' 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/iam.SharingRule" } } }, "links": { "GetIamSharingRuleByMoid": { "operationId": "GetIamSharingRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SharingRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Delete a 'iam.SharingRule' resource.", "operationId": "DeleteIamSharingRule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.SharingRule", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "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" } } }, "get": { "tags": [ "iam" ], "x-intersight-type": "SaaS", "summary": "Read a 'iam.SharingRule' resource.", "operationId": "GetIamSharingRuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.iam.SharingRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.SharingRule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.SharingRule" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamSharingRuleByMoid": { "operationId": "GetIamSharingRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/SharingRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Systems": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.System' resource.", "operationId": "GetIamSystemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.System" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.System' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.System.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Systems/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.System' resource.", "operationId": "GetIamSystemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.iam.System" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.System' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.System" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamSystemByMoid": { "operationId": "GetIamSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Systems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/TestIdpConfigurations": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.TestIdpConfiguration' resource.", "operationId": "GetIamTestIdpConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.TestIdpConfiguration", "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 'iam.TestIdpConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/TestIdpConfigurations/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.TestIdpConfiguration' resource.", "operationId": "GetIamTestIdpConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure LDAP servers", "PRIVSET.Delete LDAP servers", "PRIVSET.Edit LDAP servers", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.TestIdpConfiguration", "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 'iam.TestIdpConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamTestIdpConfigurationByMoid": { "operationId": "GetIamTestIdpConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TestIdpConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.TestIdpConfiguration' resource.", "operationId": "UpdateIamTestIdpConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.TestIdpConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.TestIdpConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.TestIdpConfiguration' resource was modified as requested. The 'iam.TestIdpConfiguration' 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/iam.TestIdpConfiguration" } } }, "links": { "GetIamTestIdpConfigurationByMoid": { "operationId": "GetIamTestIdpConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TestIdpConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.TestIdpConfiguration' resource.", "operationId": "PatchIamTestIdpConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.TestIdpConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.TestIdpConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.TestIdpConfiguration' resource was patched as requested. The 'iam.TestIdpConfiguration' 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/iam.TestIdpConfiguration" } } }, "links": { "GetIamTestIdpConfigurationByMoid": { "operationId": "GetIamTestIdpConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TestIdpConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/TrustPoints": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.TrustPoint' resource.", "operationId": "GetIamTrustPointList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted certificates", "PRIVSET.Delete trusted certificates", "PRIVSET.Devices", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Read-only SMTP policies", "PRIVSET.View Access and Permissions", "READ.iam.TrustPoint", "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 'iam.TrustPoint' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TrustPoint.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.TrustPoint' resource.", "operationId": "CreateIamTrustPoint", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.TrustPoint", "PRIVSET.Account Administrator", "PRIVSET.Add trusted certificates", "PRIVSET.Devices", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.TrustPoint' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TrustPoint" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.TrustPoint' resource was created as requested. The 'iam.TrustPoint' 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/iam.TrustPoint" } } }, "links": { "GetIamTrustPointByMoid": { "operationId": "GetIamTrustPointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TrustPoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/TrustPoints/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.TrustPoint' resource.", "operationId": "GetIamTrustPointByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add trusted certificates", "PRIVSET.Delete trusted certificates", "PRIVSET.Devices", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "PRIVSET.Read-only SMTP policies", "PRIVSET.View Access and Permissions", "READ.iam.TrustPoint", "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 'iam.TrustPoint' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.TrustPoint" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamTrustPointByMoid": { "operationId": "GetIamTrustPointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/TrustPoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.TrustPoint' resource.", "operationId": "DeleteIamTrustPoint", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.TrustPoint", "PRIVSET.Account Administrator", "PRIVSET.Delete trusted certificates", "PRIVSET.Devices", "PRIVSET.Manage Access and Permissions", "PRIVSET.Manage Identity Providers", "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/iam/Users": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.User' resource.", "operationId": "GetIamUserList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "PRIVSET.Delete notification rule or webhook", "PRIVSET.Edit notification rule or webhook", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.User", "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 'iam.User' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.User' resource.", "operationId": "CreateIamUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.User", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.User' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.User' resource was created as requested. The 'iam.User' 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/iam.User" } } }, "links": { "GetIamUserByMoid": { "operationId": "GetIamUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Users/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/Users/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.User' resource.", "operationId": "GetIamUserByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "PRIVSET.Delete notification rule or webhook", "PRIVSET.Edit notification rule or webhook", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "PRIVSET.View sessions", "READ.iam.User", "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 'iam.User' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserByMoid": { "operationId": "GetIamUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Users/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.User' resource.", "operationId": "UpdateIamUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.User" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.User' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.User' resource was modified as requested. The 'iam.User' 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/iam.User" } } }, "links": { "GetIamUserByMoid": { "operationId": "GetIamUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Users/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.User' resource.", "operationId": "PatchIamUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.User" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.User' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.User" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.User' resource was patched as requested. The 'iam.User' 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/iam.User" } } }, "links": { "GetIamUserByMoid": { "operationId": "GetIamUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Users/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.User' resource.", "operationId": "DeleteIamUser", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.User", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "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/iam/UserGroups": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserGroup' resource.", "operationId": "GetIamUserGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.UserGroup", "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 'iam.UserGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.UserGroup' resource.", "operationId": "CreateIamUserGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.UserGroup", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.UserGroup' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserGroup' resource was created as requested. The 'iam.UserGroup' 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/iam.UserGroup" } } }, "links": { "GetIamUserGroupByMoid": { "operationId": "GetIamUserGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserGroups/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserGroup' resource.", "operationId": "GetIamUserGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.UserGroup", "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 'iam.UserGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserGroupByMoid": { "operationId": "GetIamUserGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.UserGroup' resource.", "operationId": "DeleteIamUserGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.UserGroup", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "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": [ "iam" ], "summary": "Update a 'iam.UserGroup' resource.", "operationId": "UpdateIamUserGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.UserGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserGroup' resource was modified as requested. The 'iam.UserGroup' 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/iam.UserGroup" } } }, "links": { "GetIamUserGroupByMoid": { "operationId": "GetIamUserGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.UserGroup' resource.", "operationId": "PatchIamUserGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.UserGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserGroup" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserGroup' resource was patched as requested. The 'iam.UserGroup' 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/iam.UserGroup" } } }, "links": { "GetIamUserGroupByMoid": { "operationId": "GetIamUserGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserPreferences": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserPreference' resource.", "operationId": "GetIamUserPreferenceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.UserPreference' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserPreferences/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserPreference' resource.", "operationId": "GetIamUserPreferenceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.UserPreference' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserPreferenceByMoid": { "operationId": "GetIamUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.UserPreference' resource.", "operationId": "UpdateIamUserPreference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserPreference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserPreference' resource was modified as requested. The 'iam.UserPreference' 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/iam.UserPreference" } } }, "links": { "GetIamUserPreferenceByMoid": { "operationId": "GetIamUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.UserPreference' resource.", "operationId": "PatchIamUserPreference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserPreference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserPreference" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserPreference' resource was patched as requested. The 'iam.UserPreference' 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/iam.UserPreference" } } }, "links": { "GetIamUserPreferenceByMoid": { "operationId": "GetIamUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserQualifiers": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserQualifier' resource.", "operationId": "GetIamUserQualifierList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.UserQualifier", "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 'iam.UserQualifier' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.UserQualifier' resource.", "operationId": "CreateIamUserQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.UserQualifier", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.UserQualifier' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserQualifier' resource was created as requested. The 'iam.UserQualifier' 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/iam.UserQualifier" } } }, "links": { "GetIamUserQualifierByMoid": { "operationId": "GetIamUserQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserQualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserQualifiers/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserQualifier' resource.", "operationId": "GetIamUserQualifierByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "PRIVSET.View Access and Permissions", "READ.iam.UserQualifier", "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 'iam.UserQualifier' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserQualifierByMoid": { "operationId": "GetIamUserQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserQualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.UserQualifier' resource.", "operationId": "UpdateIamUserQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.UserQualifier" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserQualifier' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserQualifier' resource was modified as requested. The 'iam.UserQualifier' 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/iam.UserQualifier" } } }, "links": { "GetIamUserQualifierByMoid": { "operationId": "GetIamUserQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserQualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.UserQualifier' resource.", "operationId": "PatchIamUserQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "ROLE.Account Administrator", "UPDATE.iam.UserQualifier" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserQualifier' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserQualifier" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserQualifier' resource was patched as requested. The 'iam.UserQualifier' 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/iam.UserQualifier" } } }, "links": { "GetIamUserQualifierByMoid": { "operationId": "GetIamUserQualifierByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserQualifiers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Delete a 'iam.UserQualifier' resource.", "operationId": "DeleteIamUserQualifier", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iam.UserQualifier", "PRIVSET.Account Administrator", "PRIVSET.Manage Access and Permissions", "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/iam/UserSettings": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserSetting' resource.", "operationId": "GetIamUserSettingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.UserSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iam.UserSetting' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Create a 'iam.UserSetting' resource.", "operationId": "CreateIamUserSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iam.UserSetting", "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iam.UserSetting' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserSetting' resource was created as requested. The 'iam.UserSetting' 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/iam.UserSetting" } } }, "links": { "GetIamUserSettingByMoid": { "operationId": "GetIamUserSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iam/UserSettings/{Moid}": { "get": { "tags": [ "iam" ], "summary": "Read a 'iam.UserSetting' resource.", "operationId": "GetIamUserSettingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.iam.UserSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iam.UserSetting' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIamUserSettingByMoid": { "operationId": "GetIamUserSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.UserSetting' resource.", "operationId": "UpdateIamUserSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.UserSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserSetting' resource was modified as requested. The 'iam.UserSetting' 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/iam.UserSetting" } } }, "links": { "GetIamUserSettingByMoid": { "operationId": "GetIamUserSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iam" ], "summary": "Update a 'iam.UserSetting' resource.", "operationId": "PatchIamUserSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Global Write Privileges", "UPDATE.iam.UserSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iam.UserSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iam.UserSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iam.UserSetting' resource was patched as requested. The 'iam.UserSetting' 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/iam.UserSetting" } } }, "links": { "GetIamUserSettingByMoid": { "operationId": "GetIamUserSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/UserSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iwotenant/MaintenanceNotifications": { "get": { "tags": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Read a 'iwotenant.MaintenanceNotification' resource.", "operationId": "GetIwotenantMaintenanceNotificationList", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iwotenant.MaintenanceNotification", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iwotenant.MaintenanceNotification' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.MaintenanceNotification.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iwotenant/MaintenanceNotifications/{Moid}": { "get": { "tags": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Read a 'iwotenant.MaintenanceNotification' resource.", "operationId": "GetIwotenantMaintenanceNotificationByMoid", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iwotenant.MaintenanceNotification", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iwotenant.MaintenanceNotification' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.MaintenanceNotification" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIwotenantMaintenanceNotificationByMoid": { "operationId": "GetIwotenantMaintenanceNotificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/MaintenanceNotifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iwotenant/Migrates": { "get": { "tags": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Read a 'iwotenant.Migrate' resource.", "operationId": "GetIwotenantMigrateList", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.iwotenant.Migrate", "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 'iwotenant.Migrate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.Migrate.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Create a 'iwotenant.Migrate' resource.", "operationId": "CreateIwotenantMigrate", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iwotenant.Migrate", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iwotenant.Migrate' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.Migrate" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iwotenant.Migrate' resource was created as requested. The 'iwotenant.Migrate' 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/iwotenant.Migrate" } } }, "links": { "GetIwotenantMigrateByMoid": { "operationId": "GetIwotenantMigrateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/Migrates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iwotenant/Migrates/{Moid}": { "get": { "tags": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Read a 'iwotenant.Migrate' resource.", "operationId": "GetIwotenantMigrateByMoid", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.iwotenant.Migrate", "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 'iwotenant.Migrate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.Migrate" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIwotenantMigrateByMoid": { "operationId": "GetIwotenantMigrateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/Migrates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Update a 'iwotenant.Migrate' resource.", "operationId": "UpdateIwotenantMigrate", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iwotenant.Migrate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iwotenant.Migrate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.Migrate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iwotenant.Migrate' resource was modified as requested. The 'iwotenant.Migrate' 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/iwotenant.Migrate" } } }, "links": { "GetIwotenantMigrateByMoid": { "operationId": "GetIwotenantMigrateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/Migrates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Update a 'iwotenant.Migrate' resource.", "operationId": "PatchIwotenantMigrate", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.iwotenant.Migrate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iwotenant.Migrate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.Migrate" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iwotenant.Migrate' resource was patched as requested. The 'iwotenant.Migrate' 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/iwotenant.Migrate" } } }, "links": { "GetIwotenantMigrateByMoid": { "operationId": "GetIwotenantMigrateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/Migrates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iwotenant/TenantCustomizations": { "get": { "tags": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Read a 'iwotenant.TenantCustomization' resource.", "operationId": "GetIwotenantTenantCustomizationList", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iwotenant.TenantCustomization", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iwotenant.TenantCustomization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.TenantCustomization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Create a 'iwotenant.TenantCustomization' resource.", "operationId": "CreateIwotenantTenantCustomization", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iwotenant.TenantCustomization", "PRIVSET.Account Administrator", "PRIVSET.Workload Optimizer Administrator", "ROLE.Account Administrator", "ROLE.Workload Optimizer Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iwotenant.TenantCustomization' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.TenantCustomization" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iwotenant.TenantCustomization' resource was created as requested. The 'iwotenant.TenantCustomization' 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/iwotenant.TenantCustomization" } } }, "links": { "GetIwotenantTenantCustomizationByMoid": { "operationId": "GetIwotenantTenantCustomizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/TenantCustomizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iwotenant/TenantCustomizations/{Moid}": { "get": { "tags": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Read a 'iwotenant.TenantCustomization' resource.", "operationId": "GetIwotenantTenantCustomizationByMoid", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workload Optimizer Administrator", "PRIVSET.Workload Optimizer Advisor", "PRIVSET.Workload Optimizer Automator", "PRIVSET.Workload Optimizer Deployer", "PRIVSET.Workload Optimizer Observer", "READ.iwotenant.TenantCustomization", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Optimizer Administrator", "ROLE.Workload Optimizer Advisor", "ROLE.Workload Optimizer Automator", "ROLE.Workload Optimizer Deployer", "ROLE.Workload Optimizer Observer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iwotenant.TenantCustomization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.TenantCustomization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIwotenantTenantCustomizationByMoid": { "operationId": "GetIwotenantTenantCustomizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/TenantCustomizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Update a 'iwotenant.TenantCustomization' resource.", "operationId": "UpdateIwotenantTenantCustomization", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Optimizer Administrator", "ROLE.Account Administrator", "ROLE.Workload Optimizer Administrator", "UPDATE.iwotenant.TenantCustomization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iwotenant.TenantCustomization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.TenantCustomization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iwotenant.TenantCustomization' resource was modified as requested. The 'iwotenant.TenantCustomization' 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/iwotenant.TenantCustomization" } } }, "links": { "GetIwotenantTenantCustomizationByMoid": { "operationId": "GetIwotenantTenantCustomizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/TenantCustomizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Update a 'iwotenant.TenantCustomization' resource.", "operationId": "PatchIwotenantTenantCustomization", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Optimizer Administrator", "ROLE.Account Administrator", "ROLE.Workload Optimizer Administrator", "UPDATE.iwotenant.TenantCustomization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iwotenant.TenantCustomization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.TenantCustomization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iwotenant.TenantCustomization' resource was patched as requested. The 'iwotenant.TenantCustomization' 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/iwotenant.TenantCustomization" } } }, "links": { "GetIwotenantTenantCustomizationByMoid": { "operationId": "GetIwotenantTenantCustomizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/TenantCustomizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Delete a 'iwotenant.TenantCustomization' resource.", "operationId": "DeleteIwotenantTenantCustomization", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iwotenant.TenantCustomization", "PRIVSET.Account Administrator", "PRIVSET.Workload Optimizer Administrator", "ROLE.Account Administrator", "ROLE.Workload Optimizer 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/iwotenant/TenantStatuses": { "get": { "tags": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Read a 'iwotenant.TenantStatus' resource.", "operationId": "GetIwotenantTenantStatusList", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.iwotenant.TenantStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iwotenant.TenantStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.TenantStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iwotenant/TenantStatuses/{Moid}": { "get": { "tags": [ "iwotenant" ], "x-intersight-type": "SaaS", "summary": "Read a 'iwotenant.TenantStatus' resource.", "operationId": "GetIwotenantTenantStatusByMoid", "deprecated": true, "x-sunset": "2026-11-30", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.iwotenant.TenantStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iwotenant.TenantStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iwotenant.TenantStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetIwotenantTenantStatusByMoid": { "operationId": "GetIwotenantTenantStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iwotenant/TenantStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/AccountLicenseData": { "get": { "tags": [ "license" ], "summary": "Read a 'license.AccountLicenseData' resource.", "operationId": "GetLicenseAccountLicenseDataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.View Licensing Status", "READ.license.AccountLicenseData", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.AccountLicenseData' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/AccountLicenseData/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.AccountLicenseData' resource.", "operationId": "GetLicenseAccountLicenseDataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.View Licensing Status", "READ.license.AccountLicenseData", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.AccountLicenseData' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseAccountLicenseDataByMoid": { "operationId": "GetLicenseAccountLicenseDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/AccountLicenseData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.AccountLicenseData' resource.", "operationId": "UpdateLicenseAccountLicenseData", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.AccountLicenseData" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.AccountLicenseData' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.AccountLicenseData' resource was modified as requested. The 'license.AccountLicenseData' 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/license.AccountLicenseData" } } }, "links": { "GetLicenseAccountLicenseDataByMoid": { "operationId": "GetLicenseAccountLicenseDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/AccountLicenseData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.AccountLicenseData' resource.", "operationId": "PatchLicenseAccountLicenseData", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.AccountLicenseData" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.AccountLicenseData' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.AccountLicenseData" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.AccountLicenseData' resource was patched as requested. The 'license.AccountLicenseData' 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/license.AccountLicenseData" } } }, "links": { "GetLicenseAccountLicenseDataByMoid": { "operationId": "GetLicenseAccountLicenseDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/AccountLicenseData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/CustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.CustomerOp' resource.", "operationId": "GetLicenseCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.CustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.CustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/CustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.CustomerOp' resource.", "operationId": "GetLicenseCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.CustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.CustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseCustomerOpByMoid": { "operationId": "GetLicenseCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/CustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.CustomerOp' resource.", "operationId": "UpdateLicenseCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.CustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.CustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.CustomerOp' resource was modified as requested. The 'license.CustomerOp' 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/license.CustomerOp" } } }, "links": { "GetLicenseCustomerOpByMoid": { "operationId": "GetLicenseCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/CustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.CustomerOp' resource.", "operationId": "PatchLicenseCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.CustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.CustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.CustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.CustomerOp' resource was patched as requested. The 'license.CustomerOp' 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/license.CustomerOp" } } }, "links": { "GetLicenseCustomerOpByMoid": { "operationId": "GetLicenseCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/CustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/ErpCustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.ErpCustomerOp' resource.", "operationId": "GetLicenseErpCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.ErpCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.ErpCustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/ErpCustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.ErpCustomerOp' resource.", "operationId": "GetLicenseErpCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.ErpCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.ErpCustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseErpCustomerOpByMoid": { "operationId": "GetLicenseErpCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.ErpCustomerOp' resource.", "operationId": "UpdateLicenseErpCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.ErpCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.ErpCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.ErpCustomerOp' resource was modified as requested. The 'license.ErpCustomerOp' 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/license.ErpCustomerOp" } } }, "links": { "GetLicenseErpCustomerOpByMoid": { "operationId": "GetLicenseErpCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.ErpCustomerOp' resource.", "operationId": "PatchLicenseErpCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.ErpCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.ErpCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.ErpCustomerOp' resource was patched as requested. The 'license.ErpCustomerOp' 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/license.ErpCustomerOp" } } }, "links": { "GetLicenseErpCustomerOpByMoid": { "operationId": "GetLicenseErpCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/ErpLicenseCounts": { "get": { "tags": [ "license" ], "summary": "Read a 'license.ErpLicenseCount' resource.", "operationId": "GetLicenseErpLicenseCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.ErpLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.ErpLicenseCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpLicenseCount.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Create a 'license.ErpLicenseCount' resource.", "operationId": "CreateLicenseErpLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.ErpLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.ErpLicenseCount' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpLicenseCount" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.ErpLicenseCount' resource was created as requested. The 'license.ErpLicenseCount' 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/license.ErpLicenseCount" } } }, "links": { "GetLicenseErpLicenseCountByMoid": { "operationId": "GetLicenseErpLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/ErpLicenseCounts/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.ErpLicenseCount' resource.", "operationId": "GetLicenseErpLicenseCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.ErpLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.ErpLicenseCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.ErpLicenseCount" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseErpLicenseCountByMoid": { "operationId": "GetLicenseErpLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/ErpLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IksCustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IksCustomerOp' resource.", "operationId": "GetLicenseIksCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IksCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IksCustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IksCustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IksCustomerOp' resource.", "operationId": "GetLicenseIksCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IksCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IksCustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIksCustomerOpByMoid": { "operationId": "GetLicenseIksCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IksCustomerOp' resource.", "operationId": "UpdateLicenseIksCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IksCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IksCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksCustomerOp' resource was modified as requested. The 'license.IksCustomerOp' 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/license.IksCustomerOp" } } }, "links": { "GetLicenseIksCustomerOpByMoid": { "operationId": "GetLicenseIksCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IksCustomerOp' resource.", "operationId": "PatchLicenseIksCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IksCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IksCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksCustomerOp' resource was patched as requested. The 'license.IksCustomerOp' 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/license.IksCustomerOp" } } }, "links": { "GetLicenseIksCustomerOpByMoid": { "operationId": "GetLicenseIksCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IksLicenseCounts": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IksLicenseCount' resource.", "operationId": "GetLicenseIksLicenseCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IksLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IksLicenseCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Create a 'license.IksLicenseCount' resource.", "operationId": "CreateLicenseIksLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.IksLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.IksLicenseCount' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksLicenseCount' resource was created as requested. The 'license.IksLicenseCount' 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/license.IksLicenseCount" } } }, "links": { "GetLicenseIksLicenseCountByMoid": { "operationId": "GetLicenseIksLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IksLicenseCounts/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IksLicenseCount' resource.", "operationId": "GetLicenseIksLicenseCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IksLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IksLicenseCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIksLicenseCountByMoid": { "operationId": "GetLicenseIksLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IksLicenseCount' resource.", "operationId": "UpdateLicenseIksLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IksLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IksLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksLicenseCount' resource was modified as requested. The 'license.IksLicenseCount' 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/license.IksLicenseCount" } } }, "links": { "GetLicenseIksLicenseCountByMoid": { "operationId": "GetLicenseIksLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IksLicenseCount' resource.", "operationId": "PatchLicenseIksLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IksLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IksLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IksLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IksLicenseCount' resource was patched as requested. The 'license.IksLicenseCount' 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/license.IksLicenseCount" } } }, "links": { "GetLicenseIksLicenseCountByMoid": { "operationId": "GetLicenseIksLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IksLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IncCustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IncCustomerOp' resource.", "operationId": "GetLicenseIncCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IncCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IncCustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IncCustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IncCustomerOp' resource.", "operationId": "GetLicenseIncCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IncCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IncCustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIncCustomerOpByMoid": { "operationId": "GetLicenseIncCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IncCustomerOp' resource.", "operationId": "UpdateLicenseIncCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IncCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IncCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncCustomerOp' resource was modified as requested. The 'license.IncCustomerOp' 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/license.IncCustomerOp" } } }, "links": { "GetLicenseIncCustomerOpByMoid": { "operationId": "GetLicenseIncCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IncCustomerOp' resource.", "operationId": "PatchLicenseIncCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IncCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IncCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncCustomerOp' resource was patched as requested. The 'license.IncCustomerOp' 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/license.IncCustomerOp" } } }, "links": { "GetLicenseIncCustomerOpByMoid": { "operationId": "GetLicenseIncCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IncLicenseCounts": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IncLicenseCount' resource.", "operationId": "GetLicenseIncLicenseCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IncLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IncLicenseCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Create a 'license.IncLicenseCount' resource.", "operationId": "CreateLicenseIncLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.IncLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.IncLicenseCount' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncLicenseCount' resource was created as requested. The 'license.IncLicenseCount' 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/license.IncLicenseCount" } } }, "links": { "GetLicenseIncLicenseCountByMoid": { "operationId": "GetLicenseIncLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IncLicenseCounts/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IncLicenseCount' resource.", "operationId": "GetLicenseIncLicenseCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IncLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IncLicenseCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIncLicenseCountByMoid": { "operationId": "GetLicenseIncLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IncLicenseCount' resource.", "operationId": "UpdateLicenseIncLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IncLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IncLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncLicenseCount' resource was modified as requested. The 'license.IncLicenseCount' 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/license.IncLicenseCount" } } }, "links": { "GetLicenseIncLicenseCountByMoid": { "operationId": "GetLicenseIncLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IncLicenseCount' resource.", "operationId": "PatchLicenseIncLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IncLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IncLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IncLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IncLicenseCount' resource was patched as requested. The 'license.IncLicenseCount' 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/license.IncLicenseCount" } } }, "links": { "GetLicenseIncLicenseCountByMoid": { "operationId": "GetLicenseIncLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IncLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IwoCustomerOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IwoCustomerOp' resource.", "operationId": "GetLicenseIwoCustomerOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IwoCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IwoCustomerOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IwoCustomerOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IwoCustomerOp' resource.", "operationId": "GetLicenseIwoCustomerOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IwoCustomerOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IwoCustomerOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIwoCustomerOpByMoid": { "operationId": "GetLicenseIwoCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IwoCustomerOp' resource.", "operationId": "UpdateLicenseIwoCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.IwoCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IwoCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoCustomerOp' resource was modified as requested. The 'license.IwoCustomerOp' 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/license.IwoCustomerOp" } } }, "links": { "GetLicenseIwoCustomerOpByMoid": { "operationId": "GetLicenseIwoCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IwoCustomerOp' resource.", "operationId": "PatchLicenseIwoCustomerOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage products", "ROLE.Account Administrator", "UPDATE.license.IwoCustomerOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IwoCustomerOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoCustomerOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoCustomerOp' resource was patched as requested. The 'license.IwoCustomerOp' 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/license.IwoCustomerOp" } } }, "links": { "GetLicenseIwoCustomerOpByMoid": { "operationId": "GetLicenseIwoCustomerOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoCustomerOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IwoLicenseCounts": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IwoLicenseCount' resource.", "operationId": "GetLicenseIwoLicenseCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IwoLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.IwoLicenseCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Create a 'license.IwoLicenseCount' resource.", "operationId": "CreateLicenseIwoLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.IwoLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.IwoLicenseCount' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoLicenseCount' resource was created as requested. The 'license.IwoLicenseCount' 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/license.IwoLicenseCount" } } }, "links": { "GetLicenseIwoLicenseCountByMoid": { "operationId": "GetLicenseIwoLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/IwoLicenseCounts/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.IwoLicenseCount' resource.", "operationId": "GetLicenseIwoLicenseCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.IwoLicenseCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.IwoLicenseCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseIwoLicenseCountByMoid": { "operationId": "GetLicenseIwoLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IwoLicenseCount' resource.", "operationId": "UpdateLicenseIwoLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IwoLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IwoLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoLicenseCount' resource was modified as requested. The 'license.IwoLicenseCount' 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/license.IwoLicenseCount" } } }, "links": { "GetLicenseIwoLicenseCountByMoid": { "operationId": "GetLicenseIwoLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.IwoLicenseCount' resource.", "operationId": "PatchLicenseIwoLicenseCount", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.IwoLicenseCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.IwoLicenseCount' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.IwoLicenseCount" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.IwoLicenseCount' resource was patched as requested. The 'license.IwoLicenseCount' 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/license.IwoLicenseCount" } } }, "links": { "GetLicenseIwoLicenseCountByMoid": { "operationId": "GetLicenseIwoLicenseCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/IwoLicenseCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseInfos": { "get": { "tags": [ "license" ], "x-intersight-type": "SaaS", "summary": "Read a 'license.LicenseInfo' resource.", "operationId": "GetLicenseLicenseInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.View Licensing Status", "READ.license.LicenseInfo", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.LicenseInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "x-intersight-type": "SaaS", "summary": "Create a 'license.LicenseInfo' resource.", "operationId": "CreateLicenseLicenseInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.LicenseInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseInfo' resource was created as requested. The 'license.LicenseInfo' 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/license.LicenseInfo" } } }, "links": { "GetLicenseLicenseInfoByMoid": { "operationId": "GetLicenseLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseInfos/{Moid}": { "get": { "tags": [ "license" ], "x-intersight-type": "SaaS", "summary": "Read a 'license.LicenseInfo' resource.", "operationId": "GetLicenseLicenseInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.View Licensing Status", "READ.license.LicenseInfo", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.LicenseInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseLicenseInfoByMoid": { "operationId": "GetLicenseLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "x-intersight-type": "SaaS", "summary": "Update a 'license.LicenseInfo' resource.", "operationId": "UpdateLicenseLicenseInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseInfo' resource was modified as requested. The 'license.LicenseInfo' 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/license.LicenseInfo" } } }, "links": { "GetLicenseLicenseInfoByMoid": { "operationId": "GetLicenseLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "x-intersight-type": "SaaS", "summary": "Update a 'license.LicenseInfo' resource.", "operationId": "PatchLicenseLicenseInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfo" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseInfo' resource was patched as requested. The 'license.LicenseInfo' 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/license.LicenseInfo" } } }, "links": { "GetLicenseLicenseInfoByMoid": { "operationId": "GetLicenseLicenseInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseInfoViews": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseInfoView' resource.", "operationId": "GetLicenseLicenseInfoViewList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseInfoView", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.LicenseInfoView' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfoView.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseInfoViews/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseInfoView' resource.", "operationId": "GetLicenseLicenseInfoViewByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Global Read Privileges", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseInfoView", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.LicenseInfoView' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseInfoView" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseLicenseInfoViewByMoid": { "operationId": "GetLicenseLicenseInfoViewByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseInfoViews/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseRegistrationStatuses": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseRegistrationStatus' resource.", "operationId": "GetLicenseLicenseRegistrationStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseRegistrationStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.LicenseRegistrationStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseRegistrationStatuses/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseRegistrationStatus' resource.", "operationId": "GetLicenseLicenseRegistrationStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseRegistrationStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.LicenseRegistrationStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseLicenseRegistrationStatusByMoid": { "operationId": "GetLicenseLicenseRegistrationStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseRegistrationStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.LicenseRegistrationStatus' resource.", "operationId": "UpdateLicenseLicenseRegistrationStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseRegistrationStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseRegistrationStatus' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseRegistrationStatus' resource was modified as requested. The 'license.LicenseRegistrationStatus' 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/license.LicenseRegistrationStatus" } } }, "links": { "GetLicenseLicenseRegistrationStatusByMoid": { "operationId": "GetLicenseLicenseRegistrationStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseRegistrationStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.LicenseRegistrationStatus' resource.", "operationId": "PatchLicenseLicenseRegistrationStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseRegistrationStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseRegistrationStatus' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseRegistrationStatus' resource was patched as requested. The 'license.LicenseRegistrationStatus' 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/license.LicenseRegistrationStatus" } } }, "links": { "GetLicenseLicenseRegistrationStatusByMoid": { "operationId": "GetLicenseLicenseRegistrationStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseRegistrationStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseReservationOps": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseReservationOp' resource.", "operationId": "GetLicenseLicenseReservationOpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseReservationOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.LicenseReservationOp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Create a 'license.LicenseReservationOp' resource.", "operationId": "CreateLicenseLicenseReservationOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.license.LicenseReservationOp", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'license.LicenseReservationOp' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseReservationOp' resource was created as requested. The 'license.LicenseReservationOp' 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/license.LicenseReservationOp" } } }, "links": { "GetLicenseLicenseReservationOpByMoid": { "operationId": "GetLicenseLicenseReservationOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseReservationOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/LicenseReservationOps/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.LicenseReservationOp' resource.", "operationId": "GetLicenseLicenseReservationOpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.LicenseReservationOp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.LicenseReservationOp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseLicenseReservationOpByMoid": { "operationId": "GetLicenseLicenseReservationOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseReservationOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.LicenseReservationOp' resource.", "operationId": "UpdateLicenseLicenseReservationOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseReservationOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseReservationOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseReservationOp' resource was modified as requested. The 'license.LicenseReservationOp' 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/license.LicenseReservationOp" } } }, "links": { "GetLicenseLicenseReservationOpByMoid": { "operationId": "GetLicenseLicenseReservationOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseReservationOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.LicenseReservationOp' resource.", "operationId": "PatchLicenseLicenseReservationOp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.LicenseReservationOp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.LicenseReservationOp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.LicenseReservationOp" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.LicenseReservationOp' resource was patched as requested. The 'license.LicenseReservationOp' 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/license.LicenseReservationOp" } } }, "links": { "GetLicenseLicenseReservationOpByMoid": { "operationId": "GetLicenseLicenseReservationOpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/LicenseReservationOps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/SmartlicenseTokens": { "get": { "tags": [ "license" ], "summary": "Read a 'license.SmartlicenseToken' resource.", "operationId": "GetLicenseSmartlicenseTokenList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.SmartlicenseToken", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'license.SmartlicenseToken' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/license/SmartlicenseTokens/{Moid}": { "get": { "tags": [ "license" ], "summary": "Read a 'license.SmartlicenseToken' resource.", "operationId": "GetLicenseSmartlicenseTokenByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only licensing", "PRIVSET.View Licensing Status", "READ.license.SmartlicenseToken", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'license.SmartlicenseToken' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetLicenseSmartlicenseTokenByMoid": { "operationId": "GetLicenseSmartlicenseTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/SmartlicenseTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.SmartlicenseToken' resource.", "operationId": "UpdateLicenseSmartlicenseToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.SmartlicenseToken" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.SmartlicenseToken' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.SmartlicenseToken' resource was modified as requested. The 'license.SmartlicenseToken' 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/license.SmartlicenseToken" } } }, "links": { "GetLicenseSmartlicenseTokenByMoid": { "operationId": "GetLicenseSmartlicenseTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/SmartlicenseTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "license" ], "summary": "Update a 'license.SmartlicenseToken' resource.", "operationId": "PatchLicenseSmartlicenseToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.license.SmartlicenseToken" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'license.SmartlicenseToken' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/license.SmartlicenseToken" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'license.SmartlicenseToken' resource was patched as requested. The 'license.SmartlicenseToken' 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/license.SmartlicenseToken" } } }, "links": { "GetLicenseSmartlicenseTokenByMoid": { "operationId": "GetLicenseSmartlicenseTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/license/SmartlicenseTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meta/Definitions": { "get": { "tags": [ "meta" ], "x-intersight-type": "SaaS", "summary": "Read a 'meta.Definition' resource.", "operationId": "GetMetaDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.meta.Definition" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'meta.Definition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meta.Definition.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/meta/Definitions/{Moid}": { "get": { "tags": [ "meta" ], "x-intersight-type": "SaaS", "summary": "Read a 'meta.Definition' resource.", "operationId": "GetMetaDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.meta.Definition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'meta.Definition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meta.Definition" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMetaDefinitionByMoid": { "operationId": "GetMetaDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/meta/Definitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/metrics/Configurations": { "get": { "tags": [ "metrics" ], "summary": "Read a 'metrics.Configuration' resource.", "operationId": "GetMetricsConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Read-only metrics explorations", "READ.metrics.Configuration", "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 'metrics.Configuration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.Configuration.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/metrics/Configurations/{Moid}": { "get": { "tags": [ "metrics" ], "summary": "Read a 'metrics.Configuration' resource.", "operationId": "GetMetricsConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Read-only metrics explorations", "READ.metrics.Configuration", "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 'metrics.Configuration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.Configuration" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMetricsConfigurationByMoid": { "operationId": "GetMetricsConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/Configurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Update a 'metrics.Configuration' resource.", "operationId": "UpdateMetricsConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "ROLE.Account Administrator", "UPDATE.metrics.Configuration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'metrics.Configuration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.Configuration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'metrics.Configuration' resource was modified as requested. The 'metrics.Configuration' 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/metrics.Configuration" } } }, "links": { "GetMetricsConfigurationByMoid": { "operationId": "GetMetricsConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/Configurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Update a 'metrics.Configuration' resource.", "operationId": "PatchMetricsConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "ROLE.Account Administrator", "UPDATE.metrics.Configuration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'metrics.Configuration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.Configuration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'metrics.Configuration' resource was patched as requested. The 'metrics.Configuration' 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/metrics.Configuration" } } }, "links": { "GetMetricsConfigurationByMoid": { "operationId": "GetMetricsConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/Configurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/metrics/MetricsExplorations": { "get": { "tags": [ "metrics" ], "summary": "Read a 'metrics.MetricsExploration' resource.", "operationId": "GetMetricsMetricsExplorationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Configure metrics settings", "PRIVSET.Global System Privileges", "PRIVSET.Read-only metrics explorations", "READ.metrics.MetricsExploration" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'metrics.MetricsExploration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.MetricsExploration.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Create a 'metrics.MetricsExploration' resource.", "operationId": "CreateMetricsMetricsExploration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.metrics.MetricsExploration", "PRIVSET.Account Administrator", "PRIVSET.Save and clone explorations", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'metrics.MetricsExploration' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.MetricsExploration" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'metrics.MetricsExploration' resource was created as requested. The 'metrics.MetricsExploration' 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/metrics.MetricsExploration" } } }, "links": { "GetMetricsMetricsExplorationByMoid": { "operationId": "GetMetricsMetricsExplorationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/MetricsExplorations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/metrics/MetricsExplorations/{Moid}": { "get": { "tags": [ "metrics" ], "summary": "Read a 'metrics.MetricsExploration' resource.", "operationId": "GetMetricsMetricsExplorationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Configure metrics settings", "PRIVSET.Global System Privileges", "PRIVSET.Read-only metrics explorations", "READ.metrics.MetricsExploration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'metrics.MetricsExploration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.MetricsExploration" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMetricsMetricsExplorationByMoid": { "operationId": "GetMetricsMetricsExplorationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/MetricsExplorations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Update a 'metrics.MetricsExploration' resource.", "operationId": "UpdateMetricsMetricsExploration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Save and clone explorations", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.metrics.MetricsExploration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'metrics.MetricsExploration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.MetricsExploration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'metrics.MetricsExploration' resource was modified as requested. The 'metrics.MetricsExploration' 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/metrics.MetricsExploration" } } }, "links": { "GetMetricsMetricsExplorationByMoid": { "operationId": "GetMetricsMetricsExplorationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/MetricsExplorations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Update a 'metrics.MetricsExploration' resource.", "operationId": "PatchMetricsMetricsExploration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Save and clone explorations", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.metrics.MetricsExploration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'metrics.MetricsExploration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.MetricsExploration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'metrics.MetricsExploration' resource was patched as requested. The 'metrics.MetricsExploration' 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/metrics.MetricsExploration" } } }, "links": { "GetMetricsMetricsExplorationByMoid": { "operationId": "GetMetricsMetricsExplorationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/MetricsExplorations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Delete a 'metrics.MetricsExploration' resource.", "operationId": "DeleteMetricsMetricsExploration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.metrics.MetricsExploration", "PRIVSET.Account Administrator", "PRIVSET.Delete explorations", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Telemetry", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain 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/metrics/ResourceConfigurations": { "get": { "tags": [ "metrics" ], "summary": "Read a 'metrics.ResourceConfiguration' resource.", "operationId": "GetMetricsResourceConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "READ.metrics.ResourceConfiguration", "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 'metrics.ResourceConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.ResourceConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Create a 'metrics.ResourceConfiguration' resource.", "operationId": "CreateMetricsResourceConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.metrics.ResourceConfiguration", "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'metrics.ResourceConfiguration' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.ResourceConfiguration" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'metrics.ResourceConfiguration' resource was created as requested. The 'metrics.ResourceConfiguration' 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/metrics.ResourceConfiguration" } } }, "links": { "GetMetricsResourceConfigurationByMoid": { "operationId": "GetMetricsResourceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/ResourceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/metrics/ResourceConfigurations/{Moid}": { "get": { "tags": [ "metrics" ], "summary": "Read a 'metrics.ResourceConfiguration' resource.", "operationId": "GetMetricsResourceConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "READ.metrics.ResourceConfiguration", "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 'metrics.ResourceConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.ResourceConfiguration" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMetricsResourceConfigurationByMoid": { "operationId": "GetMetricsResourceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/ResourceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Update a 'metrics.ResourceConfiguration' resource.", "operationId": "UpdateMetricsResourceConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "ROLE.Account Administrator", "UPDATE.metrics.ResourceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'metrics.ResourceConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.ResourceConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'metrics.ResourceConfiguration' resource was modified as requested. The 'metrics.ResourceConfiguration' 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/metrics.ResourceConfiguration" } } }, "links": { "GetMetricsResourceConfigurationByMoid": { "operationId": "GetMetricsResourceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/ResourceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "metrics" ], "summary": "Update a 'metrics.ResourceConfiguration' resource.", "operationId": "PatchMetricsResourceConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "ROLE.Account Administrator", "UPDATE.metrics.ResourceConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'metrics.ResourceConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/metrics.ResourceConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'metrics.ResourceConfiguration' resource was patched as requested. The 'metrics.ResourceConfiguration' 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/metrics.ResourceConfiguration" } } }, "links": { "GetMetricsResourceConfigurationByMoid": { "operationId": "GetMetricsResourceConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/metrics/ResourceConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/BackupCategories": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.BackupCategory' resource.", "operationId": "GetMgmtBackupCategoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.mgmt.BackupCategory" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'mgmt.BackupCategory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.BackupCategory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/BackupCategories/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.BackupCategory' resource.", "operationId": "GetMgmtBackupCategoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.mgmt.BackupCategory" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'mgmt.BackupCategory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.BackupCategory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtBackupCategoryByMoid": { "operationId": "GetMgmtBackupCategoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/BackupCategories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigBackupFiles": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigBackupFile' resource.", "operationId": "GetMgmtConfigBackupFileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.mgmt.ConfigBackupFile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'mgmt.ConfigBackupFile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupFile.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Create a 'mgmt.ConfigBackupFile' resource.", "operationId": "CreateMgmtConfigBackupFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.mgmt.ConfigBackupFile", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigBackupFile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupFile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigBackupFile' resource was created as requested. The 'mgmt.ConfigBackupFile' 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/mgmt.ConfigBackupFile" } } }, "links": { "GetMgmtConfigBackupFileByMoid": { "operationId": "GetMgmtConfigBackupFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigBackupFiles/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigBackupFile' resource.", "operationId": "GetMgmtConfigBackupFileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.mgmt.ConfigBackupFile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'mgmt.ConfigBackupFile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupFile" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtConfigBackupFileByMoid": { "operationId": "GetMgmtConfigBackupFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Update a 'mgmt.ConfigBackupFile' resource.", "operationId": "UpdateMgmtConfigBackupFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.mgmt.ConfigBackupFile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigBackupFile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupFile" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigBackupFile' resource was modified as requested. The 'mgmt.ConfigBackupFile' 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/mgmt.ConfigBackupFile" } } }, "links": { "GetMgmtConfigBackupFileByMoid": { "operationId": "GetMgmtConfigBackupFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Update a 'mgmt.ConfigBackupFile' resource.", "operationId": "PatchMgmtConfigBackupFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.mgmt.ConfigBackupFile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigBackupFile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupFile" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigBackupFile' resource was patched as requested. The 'mgmt.ConfigBackupFile' 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/mgmt.ConfigBackupFile" } } }, "links": { "GetMgmtConfigBackupFileByMoid": { "operationId": "GetMgmtConfigBackupFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Delete a 'mgmt.ConfigBackupFile' resource.", "operationId": "DeleteMgmtConfigBackupFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.mgmt.ConfigBackupFile", "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/mgmt/ConfigBackupInstances": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigBackupInstance' resource.", "operationId": "GetMgmtConfigBackupInstanceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigBackupInstance", "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 'mgmt.ConfigBackupInstance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigBackupInstances/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigBackupInstance' resource.", "operationId": "GetMgmtConfigBackupInstanceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigBackupInstance", "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 'mgmt.ConfigBackupInstance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtConfigBackupInstanceByMoid": { "operationId": "GetMgmtConfigBackupInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Update a 'mgmt.ConfigBackupInstance' resource.", "operationId": "UpdateMgmtConfigBackupInstance", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.mgmt.ConfigBackupInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigBackupInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigBackupInstance' resource was modified as requested. The 'mgmt.ConfigBackupInstance' 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/mgmt.ConfigBackupInstance" } } }, "links": { "GetMgmtConfigBackupInstanceByMoid": { "operationId": "GetMgmtConfigBackupInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Update a 'mgmt.ConfigBackupInstance' resource.", "operationId": "PatchMgmtConfigBackupInstance", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.mgmt.ConfigBackupInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigBackupInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigBackupInstance' resource was patched as requested. The 'mgmt.ConfigBackupInstance' 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/mgmt.ConfigBackupInstance" } } }, "links": { "GetMgmtConfigBackupInstanceByMoid": { "operationId": "GetMgmtConfigBackupInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Delete a 'mgmt.ConfigBackupInstance' resource.", "operationId": "DeleteMgmtConfigBackupInstance", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.mgmt.ConfigBackupInstance", "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/mgmt/ConfigBackupOperations": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigBackupOperation' resource.", "operationId": "GetMgmtConfigBackupOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigBackupOperation", "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 'mgmt.ConfigBackupOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Create a 'mgmt.ConfigBackupOperation' resource.", "operationId": "CreateMgmtConfigBackupOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.mgmt.ConfigBackupOperation", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigBackupOperation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigBackupOperation' resource was created as requested. The 'mgmt.ConfigBackupOperation' 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/mgmt.ConfigBackupOperation" } } }, "links": { "GetMgmtConfigBackupOperationByMoid": { "operationId": "GetMgmtConfigBackupOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigBackupOperations/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigBackupOperation' resource.", "operationId": "GetMgmtConfigBackupOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigBackupOperation", "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 'mgmt.ConfigBackupOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtConfigBackupOperationByMoid": { "operationId": "GetMgmtConfigBackupOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Update a 'mgmt.ConfigBackupOperation' resource.", "operationId": "UpdateMgmtConfigBackupOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.mgmt.ConfigBackupOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigBackupOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigBackupOperation' resource was modified as requested. The 'mgmt.ConfigBackupOperation' 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/mgmt.ConfigBackupOperation" } } }, "links": { "GetMgmtConfigBackupOperationByMoid": { "operationId": "GetMgmtConfigBackupOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Update a 'mgmt.ConfigBackupOperation' resource.", "operationId": "PatchMgmtConfigBackupOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.mgmt.ConfigBackupOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigBackupOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigBackupOperation' resource was patched as requested. The 'mgmt.ConfigBackupOperation' 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/mgmt.ConfigBackupOperation" } } }, "links": { "GetMgmtConfigBackupOperationByMoid": { "operationId": "GetMgmtConfigBackupOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigBackupOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Delete a 'mgmt.ConfigBackupOperation' resource.", "operationId": "DeleteMgmtConfigBackupOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.mgmt.ConfigBackupOperation", "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/mgmt/ConfigCategorySummaries": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigCategorySummary' resource.", "operationId": "GetMgmtConfigCategorySummaryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigCategorySummary", "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 'mgmt.ConfigCategorySummary' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigCategorySummary.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigCategorySummaries/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigCategorySummary' resource.", "operationId": "GetMgmtConfigCategorySummaryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigCategorySummary", "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 'mgmt.ConfigCategorySummary' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigCategorySummary" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtConfigCategorySummaryByMoid": { "operationId": "GetMgmtConfigCategorySummaryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigCategorySummaries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigOperationSettings": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigOperationSetting' resource.", "operationId": "GetMgmtConfigOperationSettingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigOperationSetting", "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 'mgmt.ConfigOperationSetting' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigOperationSetting.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Create a 'mgmt.ConfigOperationSetting' resource.", "operationId": "CreateMgmtConfigOperationSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.mgmt.ConfigOperationSetting", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigOperationSetting' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigOperationSetting" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigOperationSetting' resource was created as requested. The 'mgmt.ConfigOperationSetting' 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/mgmt.ConfigOperationSetting" } } }, "links": { "GetMgmtConfigOperationSettingByMoid": { "operationId": "GetMgmtConfigOperationSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigOperationSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigOperationSettings/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigOperationSetting' resource.", "operationId": "GetMgmtConfigOperationSettingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigOperationSetting", "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 'mgmt.ConfigOperationSetting' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigOperationSetting" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtConfigOperationSettingByMoid": { "operationId": "GetMgmtConfigOperationSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigOperationSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Update a 'mgmt.ConfigOperationSetting' resource.", "operationId": "UpdateMgmtConfigOperationSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.mgmt.ConfigOperationSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigOperationSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigOperationSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigOperationSetting' resource was modified as requested. The 'mgmt.ConfigOperationSetting' 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/mgmt.ConfigOperationSetting" } } }, "links": { "GetMgmtConfigOperationSettingByMoid": { "operationId": "GetMgmtConfigOperationSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigOperationSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Update a 'mgmt.ConfigOperationSetting' resource.", "operationId": "PatchMgmtConfigOperationSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.mgmt.ConfigOperationSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigOperationSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigOperationSetting" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigOperationSetting' resource was patched as requested. The 'mgmt.ConfigOperationSetting' 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/mgmt.ConfigOperationSetting" } } }, "links": { "GetMgmtConfigOperationSettingByMoid": { "operationId": "GetMgmtConfigOperationSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigOperationSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Delete a 'mgmt.ConfigOperationSetting' resource.", "operationId": "DeleteMgmtConfigOperationSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.mgmt.ConfigOperationSetting", "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/mgmt/ConfigRestoreCategorySummaries": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigRestoreCategorySummary' resource.", "operationId": "GetMgmtConfigRestoreCategorySummaryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigRestoreCategorySummary", "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 'mgmt.ConfigRestoreCategorySummary' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigRestoreCategorySummary.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigRestoreCategorySummaries/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigRestoreCategorySummary' resource.", "operationId": "GetMgmtConfigRestoreCategorySummaryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigRestoreCategorySummary", "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 'mgmt.ConfigRestoreCategorySummary' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigRestoreCategorySummary" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtConfigRestoreCategorySummaryByMoid": { "operationId": "GetMgmtConfigRestoreCategorySummaryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigRestoreCategorySummaries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigRestoreOperations": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigRestoreOperation' resource.", "operationId": "GetMgmtConfigRestoreOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigRestoreOperation", "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 'mgmt.ConfigRestoreOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigRestoreOperation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Create a 'mgmt.ConfigRestoreOperation' resource.", "operationId": "CreateMgmtConfigRestoreOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.mgmt.ConfigRestoreOperation", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'mgmt.ConfigRestoreOperation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigRestoreOperation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'mgmt.ConfigRestoreOperation' resource was created as requested. The 'mgmt.ConfigRestoreOperation' 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/mgmt.ConfigRestoreOperation" } } }, "links": { "GetMgmtConfigRestoreOperationByMoid": { "operationId": "GetMgmtConfigRestoreOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigRestoreOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ConfigRestoreOperations/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ConfigRestoreOperation' resource.", "operationId": "GetMgmtConfigRestoreOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.ConfigRestoreOperation", "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 'mgmt.ConfigRestoreOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ConfigRestoreOperation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtConfigRestoreOperationByMoid": { "operationId": "GetMgmtConfigRestoreOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ConfigRestoreOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "mgmt" ], "summary": "Delete a 'mgmt.ConfigRestoreOperation' resource.", "operationId": "DeleteMgmtConfigRestoreOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.mgmt.ConfigRestoreOperation", "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/mgmt/ObjectBackupMeta": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ObjectBackupMeta' resource.", "operationId": "GetMgmtObjectBackupMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.mgmt.ObjectBackupMeta" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'mgmt.ObjectBackupMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ObjectBackupMeta.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/ObjectBackupMeta/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.ObjectBackupMeta' resource.", "operationId": "GetMgmtObjectBackupMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.mgmt.ObjectBackupMeta" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'mgmt.ObjectBackupMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.ObjectBackupMeta" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtObjectBackupMetaByMoid": { "operationId": "GetMgmtObjectBackupMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/ObjectBackupMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/OrgBackupOperations": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.OrgBackupOperation' resource.", "operationId": "GetMgmtOrgBackupOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.OrgBackupOperation", "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 'mgmt.OrgBackupOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.OrgBackupOperation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/OrgBackupOperations/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.OrgBackupOperation' resource.", "operationId": "GetMgmtOrgBackupOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.OrgBackupOperation", "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 'mgmt.OrgBackupOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.OrgBackupOperation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtOrgBackupOperationByMoid": { "operationId": "GetMgmtOrgBackupOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/OrgBackupOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/OrgRestoreOperations": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.OrgRestoreOperation' resource.", "operationId": "GetMgmtOrgRestoreOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.OrgRestoreOperation", "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 'mgmt.OrgRestoreOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.OrgRestoreOperation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/mgmt/OrgRestoreOperations/{Moid}": { "get": { "tags": [ "mgmt" ], "summary": "Read a 'mgmt.OrgRestoreOperation' resource.", "operationId": "GetMgmtOrgRestoreOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.mgmt.OrgRestoreOperation", "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 'mgmt.OrgRestoreOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mgmt.OrgRestoreOperation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMgmtOrgRestoreOperationByMoid": { "operationId": "GetMgmtOrgRestoreOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/mgmt/OrgRestoreOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/monitoring/HealthStatuses": { "get": { "tags": [ "monitoring" ], "summary": "Read a 'monitoring.HealthStatus' resource.", "operationId": "GetMonitoringHealthStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.monitoring.HealthStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'monitoring.HealthStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitoring.HealthStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/monitoring/HealthStatuses/{Moid}": { "get": { "tags": [ "monitoring" ], "summary": "Read a 'monitoring.HealthStatus' resource.", "operationId": "GetMonitoringHealthStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.monitoring.HealthStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'monitoring.HealthStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/monitoring.HealthStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetMonitoringHealthStatusByMoid": { "operationId": "GetMonitoringHealthStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/monitoring/HealthStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/notification/AccountSubscriptions": { "get": { "tags": [ "notification" ], "summary": "Read a 'notification.AccountSubscription' resource.", "operationId": "GetNotificationAccountSubscriptionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "PRIVSET.Delete notification rule or webhook", "PRIVSET.Edit notification rule or webhook", "READ.notification.AccountSubscription", "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 'notification.AccountSubscription' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "notification" ], "summary": "Create a 'notification.AccountSubscription' resource.", "operationId": "CreateNotificationAccountSubscription", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.notification.AccountSubscription", "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'notification.AccountSubscription' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'notification.AccountSubscription' resource was created as requested. The 'notification.AccountSubscription' 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/notification.AccountSubscription" } } }, "links": { "GetNotificationAccountSubscriptionByMoid": { "operationId": "GetNotificationAccountSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/notification/AccountSubscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/notification/AccountSubscriptions/{Moid}": { "get": { "tags": [ "notification" ], "summary": "Read a 'notification.AccountSubscription' resource.", "operationId": "GetNotificationAccountSubscriptionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add notification rule or webhook", "PRIVSET.Delete notification rule or webhook", "PRIVSET.Edit notification rule or webhook", "READ.notification.AccountSubscription", "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 'notification.AccountSubscription' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetNotificationAccountSubscriptionByMoid": { "operationId": "GetNotificationAccountSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/notification/AccountSubscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "notification" ], "summary": "Update a 'notification.AccountSubscription' resource.", "operationId": "UpdateNotificationAccountSubscription", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit notification rule or webhook", "ROLE.Account Administrator", "UPDATE.notification.AccountSubscription" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'notification.AccountSubscription' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'notification.AccountSubscription' resource was modified as requested. The 'notification.AccountSubscription' 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/notification.AccountSubscription" } } }, "links": { "GetNotificationAccountSubscriptionByMoid": { "operationId": "GetNotificationAccountSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/notification/AccountSubscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "notification" ], "summary": "Update a 'notification.AccountSubscription' resource.", "operationId": "PatchNotificationAccountSubscription", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit notification rule or webhook", "ROLE.Account Administrator", "UPDATE.notification.AccountSubscription" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'notification.AccountSubscription' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/notification.AccountSubscription" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'notification.AccountSubscription' resource was patched as requested. The 'notification.AccountSubscription' 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/notification.AccountSubscription" } } }, "links": { "GetNotificationAccountSubscriptionByMoid": { "operationId": "GetNotificationAccountSubscriptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/notification/AccountSubscriptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "notification" ], "summary": "Delete a 'notification.AccountSubscription' resource.", "operationId": "DeleteNotificationAccountSubscription", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.notification.AccountSubscription", "PRIVSET.Account Administrator", "PRIVSET.Delete notification rule or webhook", "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/oauth/AccessTokens": { "get": { "tags": [ "oauth" ], "summary": "Read a 'oauth.AccessToken' resource.", "operationId": "GetOauthAccessTokenList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "READ.oauth.AccessToken", "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 'oauth.AccessToken' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.AccessToken.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oauth/AccessTokens/{Moid}": { "get": { "tags": [ "oauth" ], "summary": "Read a 'oauth.AccessToken' resource.", "operationId": "GetOauthAccessTokenByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "READ.oauth.AccessToken", "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 'oauth.AccessToken' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.AccessToken" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOauthAccessTokenByMoid": { "operationId": "GetOauthAccessTokenByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/AccessTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oauth" ], "summary": "Delete a 'oauth.AccessToken' resource.", "operationId": "DeleteOauthAccessToken", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.oauth.AccessToken", "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/oauth/Authorizations": { "post": { "tags": [ "oauth" ], "summary": "Create a 'oauth.Authorization' resource.", "operationId": "CreateOauthAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.oauth.Authorization", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'oauth.Authorization' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oauth.Authorization' resource was created as requested. The 'oauth.Authorization' 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/oauth.Authorization" } } }, "links": { "GetOauthAuthorizationByMoid": { "operationId": "GetOauthAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oauth" ], "summary": "Read a 'oauth.Authorization' resource.", "operationId": "GetOauthAuthorizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "PRIVSET.Read-Only", "READ.oauth.Authorization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'oauth.Authorization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oauth/Authorizations/{Moid}": { "post": { "tags": [ "oauth" ], "summary": "Update a 'oauth.Authorization' resource.", "operationId": "UpdateOauthAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "ROLE.Account Administrator", "UPDATE.oauth.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oauth.Authorization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oauth.Authorization' resource was modified as requested. The 'oauth.Authorization' 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/oauth.Authorization" } } }, "links": { "GetOauthAuthorizationByMoid": { "operationId": "GetOauthAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oauth" ], "summary": "Update a 'oauth.Authorization' resource.", "operationId": "PatchOauthAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "ROLE.Account Administrator", "UPDATE.oauth.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oauth.Authorization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oauth.Authorization' resource was patched as requested. The 'oauth.Authorization' 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/oauth.Authorization" } } }, "links": { "GetOauthAuthorizationByMoid": { "operationId": "GetOauthAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oauth" ], "summary": "Read a 'oauth.Authorization' resource.", "operationId": "GetOauthAuthorizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Enable subscription information", "PRIVSET.Read-Only", "READ.oauth.Authorization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'oauth.Authorization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oauth.Authorization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOauthAuthorizationByMoid": { "operationId": "GetOauthAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oauth/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/onprem/ApplianceSystemInfos": { "get": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Read a 'onprem.ApplianceSystemInfo' resource.", "operationId": "GetOnpremApplianceSystemInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.onprem.ApplianceSystemInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'onprem.ApplianceSystemInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.ApplianceSystemInfo.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/onprem/ApplianceSystemInfos/{Moid}": { "get": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Read a 'onprem.ApplianceSystemInfo' resource.", "operationId": "GetOnpremApplianceSystemInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.onprem.ApplianceSystemInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'onprem.ApplianceSystemInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.ApplianceSystemInfo" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOnpremApplianceSystemInfoByMoid": { "operationId": "GetOnpremApplianceSystemInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/onprem/ApplianceSystemInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/onprem/AuditRecords": { "get": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Read a 'onprem.AuditRecord' resource.", "operationId": "GetOnpremAuditRecordList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.onprem.AuditRecord" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'onprem.AuditRecord' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.AuditRecord.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/onprem/AuditRecords/{Moid}": { "get": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Read a 'onprem.AuditRecord' resource.", "operationId": "GetOnpremAuditRecordByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.onprem.AuditRecord" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'onprem.AuditRecord' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.AuditRecord" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOnpremAuditRecordByMoid": { "operationId": "GetOnpremAuditRecordByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/onprem/AuditRecords/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/onprem/Upgrades": { "get": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Read a 'onprem.Upgrade' resource.", "operationId": "GetOnpremUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.onprem.Upgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'onprem.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/onprem.Upgrade.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/onprem/Upgrades/{Moid}": { "get": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Read a 'onprem.Upgrade' resource.", "operationId": "GetOnpremUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.onprem.Upgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'onprem.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/onprem.Upgrade" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOnpremUpgradeByMoid": { "operationId": "GetOnpremUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/onprem/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" } } }, "post": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Update a 'onprem.Upgrade' resource.", "operationId": "UpdateOnpremUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.onprem.Upgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'onprem.Upgrade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.Upgrade" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'onprem.Upgrade' resource was modified as requested. The 'onprem.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/onprem.Upgrade" } } }, "links": { "GetOnpremUpgradeByMoid": { "operationId": "GetOnpremUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/onprem/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": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Update a 'onprem.Upgrade' resource.", "operationId": "PatchOnpremUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.onprem.Upgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'onprem.Upgrade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.Upgrade" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'onprem.Upgrade' resource was patched as requested. The 'onprem.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/onprem.Upgrade" } } }, "links": { "GetOnpremUpgradeByMoid": { "operationId": "GetOnpremUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/onprem/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/onprem/UserPreferences": { "get": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Read a 'onprem.UserPreference' resource.", "operationId": "GetOnpremUserPreferenceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.onprem.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'onprem.UserPreference' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.UserPreference.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/onprem/UserPreferences/{Moid}": { "get": { "tags": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Read a 'onprem.UserPreference' resource.", "operationId": "GetOnpremUserPreferenceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.onprem.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'onprem.UserPreference' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.UserPreference" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOnpremUserPreferenceByMoid": { "operationId": "GetOnpremUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/onprem/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Update a 'onprem.UserPreference' resource.", "operationId": "UpdateOnpremUserPreference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.onprem.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'onprem.UserPreference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.UserPreference" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'onprem.UserPreference' resource was modified as requested. The 'onprem.UserPreference' 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/onprem.UserPreference" } } }, "links": { "GetOnpremUserPreferenceByMoid": { "operationId": "GetOnpremUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/onprem/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "onprem" ], "x-intersight-type": "SaaS", "summary": "Update a 'onprem.UserPreference' resource.", "operationId": "PatchOnpremUserPreference", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.onprem.UserPreference" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'onprem.UserPreference' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/onprem.UserPreference" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'onprem.UserPreference' resource was patched as requested. The 'onprem.UserPreference' 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/onprem.UserPreference" } } }, "links": { "GetOnpremUserPreferenceByMoid": { "operationId": "GetOnpremUserPreferenceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/onprem/UserPreferences/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/ApiMethodMeta": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.ApiMethodMeta' resource.", "operationId": "GetOpenapiApiMethodMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.ApiMethodMeta", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.ApiMethodMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ApiMethodMeta.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/ApiMethodMeta/{Moid}": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.ApiMethodMeta' resource.", "operationId": "GetOpenapiApiMethodMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.ApiMethodMeta", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.ApiMethodMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ApiMethodMeta" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiApiMethodMetaByMoid": { "operationId": "GetOpenapiApiMethodMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/ApiMethodMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Delete a 'openapi.ApiMethodMeta' resource.", "operationId": "DeleteOpenapiApiMethodMeta", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.ApiMethodMeta", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "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/openapi/OpenApiSpecifications": { "get": { "tags": [ "openapi" ], "summary": "Read a 'openapi.OpenApiSpecification' resource.", "operationId": "GetOpenapiOpenApiSpecificationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.OpenApiSpecification", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.OpenApiSpecification' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "summary": "Create a 'openapi.OpenApiSpecification' resource.", "operationId": "CreateOpenapiOpenApiSpecification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.openapi.OpenApiSpecification", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'openapi.OpenApiSpecification' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.OpenApiSpecification' resource was created as requested. The 'openapi.OpenApiSpecification' 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/openapi.OpenApiSpecification" } } }, "links": { "GetOpenapiOpenApiSpecificationByMoid": { "operationId": "GetOpenapiOpenApiSpecificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/OpenApiSpecifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/OpenApiSpecifications/{Moid}": { "get": { "tags": [ "openapi" ], "summary": "Read a 'openapi.OpenApiSpecification' resource.", "operationId": "GetOpenapiOpenApiSpecificationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.OpenApiSpecification", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.OpenApiSpecification' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiOpenApiSpecificationByMoid": { "operationId": "GetOpenapiOpenApiSpecificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/OpenApiSpecifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "summary": "Update a 'openapi.OpenApiSpecification' resource.", "operationId": "UpdateOpenapiOpenApiSpecification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer", "UPDATE.openapi.OpenApiSpecification" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'openapi.OpenApiSpecification' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.OpenApiSpecification' resource was modified as requested. The 'openapi.OpenApiSpecification' 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/openapi.OpenApiSpecification" } } }, "links": { "GetOpenapiOpenApiSpecificationByMoid": { "operationId": "GetOpenapiOpenApiSpecificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/OpenApiSpecifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "summary": "Update a 'openapi.OpenApiSpecification' resource.", "operationId": "PatchOpenapiOpenApiSpecification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer", "UPDATE.openapi.OpenApiSpecification" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'openapi.OpenApiSpecification' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.OpenApiSpecification' resource was patched as requested. The 'openapi.OpenApiSpecification' 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/openapi.OpenApiSpecification" } } }, "links": { "GetOpenapiOpenApiSpecificationByMoid": { "operationId": "GetOpenapiOpenApiSpecificationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/OpenApiSpecifications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "summary": "Delete a 'openapi.OpenApiSpecification' resource.", "operationId": "DeleteOpenapiOpenApiSpecification", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.OpenApiSpecification", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "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/openapi/ProcessFiles": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.ProcessFile' resource.", "operationId": "GetOpenapiProcessFileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.ProcessFile", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.ProcessFile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ProcessFile.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Create a 'openapi.ProcessFile' resource.", "operationId": "CreateOpenapiProcessFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.openapi.ProcessFile", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'openapi.ProcessFile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ProcessFile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.ProcessFile' resource was created as requested. The 'openapi.ProcessFile' 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/openapi.ProcessFile" } } }, "links": { "GetOpenapiProcessFileByMoid": { "operationId": "GetOpenapiProcessFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/ProcessFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/ProcessFiles/{Moid}": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.ProcessFile' resource.", "operationId": "GetOpenapiProcessFileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.ProcessFile", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.ProcessFile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.ProcessFile" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiProcessFileByMoid": { "operationId": "GetOpenapiProcessFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/ProcessFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Delete a 'openapi.ProcessFile' resource.", "operationId": "DeleteOpenapiProcessFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.ProcessFile", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "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/openapi/TaskGenerationRequests": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.TaskGenerationRequest' resource.", "operationId": "GetOpenapiTaskGenerationRequestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.TaskGenerationRequest", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.TaskGenerationRequest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Create a 'openapi.TaskGenerationRequest' resource.", "operationId": "CreateOpenapiTaskGenerationRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.openapi.TaskGenerationRequest", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'openapi.TaskGenerationRequest' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.TaskGenerationRequest' resource was created as requested. The 'openapi.TaskGenerationRequest' 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/openapi.TaskGenerationRequest" } } }, "links": { "GetOpenapiTaskGenerationRequestByMoid": { "operationId": "GetOpenapiTaskGenerationRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/TaskGenerationRequests/{Moid}": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.TaskGenerationRequest' resource.", "operationId": "GetOpenapiTaskGenerationRequestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.TaskGenerationRequest", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.TaskGenerationRequest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiTaskGenerationRequestByMoid": { "operationId": "GetOpenapiTaskGenerationRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Update a 'openapi.TaskGenerationRequest' resource.", "operationId": "UpdateOpenapiTaskGenerationRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer", "UPDATE.openapi.TaskGenerationRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'openapi.TaskGenerationRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.TaskGenerationRequest' resource was modified as requested. The 'openapi.TaskGenerationRequest' 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/openapi.TaskGenerationRequest" } } }, "links": { "GetOpenapiTaskGenerationRequestByMoid": { "operationId": "GetOpenapiTaskGenerationRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Update a 'openapi.TaskGenerationRequest' resource.", "operationId": "PatchOpenapiTaskGenerationRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer", "UPDATE.openapi.TaskGenerationRequest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'openapi.TaskGenerationRequest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'openapi.TaskGenerationRequest' resource was patched as requested. The 'openapi.TaskGenerationRequest' 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/openapi.TaskGenerationRequest" } } }, "links": { "GetOpenapiTaskGenerationRequestByMoid": { "operationId": "GetOpenapiTaskGenerationRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationRequests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Delete a 'openapi.TaskGenerationRequest' resource.", "operationId": "DeleteOpenapiTaskGenerationRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.TaskGenerationRequest", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "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/openapi/TaskGenerationResults": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.TaskGenerationResult' resource.", "operationId": "GetOpenapiTaskGenerationResultList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.TaskGenerationResult", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'openapi.TaskGenerationResult' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationResult.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/openapi/TaskGenerationResults/{Moid}": { "get": { "tags": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Read a 'openapi.TaskGenerationResult' resource.", "operationId": "GetOpenapiTaskGenerationResultByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.openapi.TaskGenerationResult", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'openapi.TaskGenerationResult' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/openapi.TaskGenerationResult" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOpenapiTaskGenerationResultByMoid": { "operationId": "GetOpenapiTaskGenerationResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/openapi/TaskGenerationResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "openapi" ], "x-intersight-type": "SaaS", "summary": "Delete a 'openapi.TaskGenerationResult' resource.", "operationId": "DeleteOpenapiTaskGenerationResult", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.openapi.TaskGenerationResult", "PRIVSET.Account Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Workflow Designer" ] } ], "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/oprs/Deployments": { "get": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Read a 'oprs.Deployment' resource.", "operationId": "GetOprsDeploymentList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "PRIVSET.Read-Only", "PRIVSET.View Hypervisors", "READ.oprs.Deployment", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'oprs.Deployment' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Create a 'oprs.Deployment' resource.", "operationId": "CreateOprsDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.oprs.Deployment", "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'oprs.Deployment' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.Deployment' resource was created as requested. The 'oprs.Deployment' 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/oprs.Deployment" } } }, "links": { "GetOprsDeploymentByMoid": { "operationId": "GetOprsDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oprs/Deployments/{Moid}": { "get": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Read a 'oprs.Deployment' resource.", "operationId": "GetOprsDeploymentByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "PRIVSET.Read-Only", "PRIVSET.View Hypervisors", "READ.oprs.Deployment", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'oprs.Deployment' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOprsDeploymentByMoid": { "operationId": "GetOprsDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Update a 'oprs.Deployment' resource.", "operationId": "UpdateOprsDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "ROLE.Account Administrator", "UPDATE.oprs.Deployment" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oprs.Deployment' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.Deployment' resource was modified as requested. The 'oprs.Deployment' 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/oprs.Deployment" } } }, "links": { "GetOprsDeploymentByMoid": { "operationId": "GetOprsDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Update a 'oprs.Deployment' resource.", "operationId": "PatchOprsDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "ROLE.Account Administrator", "UPDATE.oprs.Deployment" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oprs.Deployment' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.Deployment" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.Deployment' resource was patched as requested. The 'oprs.Deployment' 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/oprs.Deployment" } } }, "links": { "GetOprsDeploymentByMoid": { "operationId": "GetOprsDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/Deployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Delete a 'oprs.Deployment' resource.", "operationId": "DeleteOprsDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.oprs.Deployment", "PRIVSET.Account Administrator", "PRIVSET.Manage Hypervisors", "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/oprs/SyncTargetListMessages": { "get": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Read a 'oprs.SyncTargetListMessage' resource.", "operationId": "GetOprsSyncTargetListMessageList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.oprs.SyncTargetListMessage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'oprs.SyncTargetListMessage' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Create a 'oprs.SyncTargetListMessage' resource.", "operationId": "CreateOprsSyncTargetListMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.oprs.SyncTargetListMessage", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'oprs.SyncTargetListMessage' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.SyncTargetListMessage' resource was created as requested. The 'oprs.SyncTargetListMessage' 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/oprs.SyncTargetListMessage" } } }, "links": { "GetOprsSyncTargetListMessageByMoid": { "operationId": "GetOprsSyncTargetListMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/SyncTargetListMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/oprs/SyncTargetListMessages/{Moid}": { "get": { "tags": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Read a 'oprs.SyncTargetListMessage' resource.", "operationId": "GetOprsSyncTargetListMessageByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.oprs.SyncTargetListMessage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'oprs.SyncTargetListMessage' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOprsSyncTargetListMessageByMoid": { "operationId": "GetOprsSyncTargetListMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/SyncTargetListMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Update a 'oprs.SyncTargetListMessage' resource.", "operationId": "UpdateOprsSyncTargetListMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.oprs.SyncTargetListMessage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oprs.SyncTargetListMessage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.SyncTargetListMessage' resource was modified as requested. The 'oprs.SyncTargetListMessage' 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/oprs.SyncTargetListMessage" } } }, "links": { "GetOprsSyncTargetListMessageByMoid": { "operationId": "GetOprsSyncTargetListMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/SyncTargetListMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Update a 'oprs.SyncTargetListMessage' resource.", "operationId": "PatchOprsSyncTargetListMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.oprs.SyncTargetListMessage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'oprs.SyncTargetListMessage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'oprs.SyncTargetListMessage' resource was patched as requested. The 'oprs.SyncTargetListMessage' 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/oprs.SyncTargetListMessage" } } }, "links": { "GetOprsSyncTargetListMessageByMoid": { "operationId": "GetOprsSyncTargetListMessageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/oprs/SyncTargetListMessages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "oprs" ], "x-intersight-type": "SaaS", "summary": "Delete a 'oprs.SyncTargetListMessage' resource.", "operationId": "DeleteOprsSyncTargetListMessage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.oprs.SyncTargetListMessage", "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/organization/Organizations": { "post": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Create a 'organization.Organization' resource.", "operationId": "CreateOrganizationOrganization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.organization.Organization", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'organization.Organization' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'organization.Organization' resource was created as requested. The 'organization.Organization' 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/organization.Organization" } } }, "links": { "GetOrganizationOrganizationByMoid": { "operationId": "GetOrganizationOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/organization/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Read a 'organization.Organization' resource.", "operationId": "GetOrganizationOrganizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.organization.Organization", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'organization.Organization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/organization/Organizations/{Moid}": { "post": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Update a 'organization.Organization' resource.", "operationId": "UpdateOrganizationOrganization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.organization.Organization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'organization.Organization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'organization.Organization' resource was modified as requested. The 'organization.Organization' 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/organization.Organization" } } }, "links": { "GetOrganizationOrganizationByMoid": { "operationId": "GetOrganizationOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/organization/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Update a 'organization.Organization' resource.", "operationId": "PatchOrganizationOrganization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.organization.Organization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'organization.Organization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'organization.Organization' resource was patched as requested. The 'organization.Organization' 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/organization.Organization" } } }, "links": { "GetOrganizationOrganizationByMoid": { "operationId": "GetOrganizationOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/organization/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Delete a 'organization.Organization' resource.", "operationId": "DeleteOrganizationOrganization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.organization.Organization", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "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" } } }, "get": { "tags": [ "organization" ], "x-intersight-type": "SaaS", "summary": "Read a 'organization.Organization' resource.", "operationId": "GetOrganizationOrganizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog User", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.organization.Organization", "ROLE.Account Administrator", "ROLE.Catalog User", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'organization.Organization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/organization.Organization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetOrganizationOrganizationByMoid": { "operationId": "GetOrganizationOrganizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/organization/Organizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/DcLogs": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.DcLogs' resource.", "operationId": "GetPartnerintegrationDcLogsList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.DcLogs", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'partnerintegration.DcLogs' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DcLogs.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/DcLogs/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.DcLogs' resource.", "operationId": "GetPartnerintegrationDcLogsByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.DcLogs", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'partnerintegration.DcLogs' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DcLogs" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationDcLogsByMoid": { "operationId": "GetPartnerintegrationDcLogsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/DcLogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/DeviceConnectors": { "post": { "tags": [ "partnerintegration" ], "summary": "Create a 'partnerintegration.DeviceConnector' resource.", "operationId": "CreatePartnerintegrationDeviceConnector", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.partnerintegration.DeviceConnector", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'partnerintegration.DeviceConnector' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DeviceConnector" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.DeviceConnector' resource was created as requested. The 'partnerintegration.DeviceConnector' 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/partnerintegration.DeviceConnector" } } }, "links": { "GetPartnerintegrationDeviceConnectorByMoid": { "operationId": "GetPartnerintegrationDeviceConnectorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/DeviceConnectors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.DeviceConnector' resource.", "operationId": "GetPartnerintegrationDeviceConnectorList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.partnerintegration.DeviceConnector", "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 'partnerintegration.DeviceConnector' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DeviceConnector.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/DeviceConnectors/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.DeviceConnector' resource.", "operationId": "GetPartnerintegrationDeviceConnectorByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.partnerintegration.DeviceConnector", "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 'partnerintegration.DeviceConnector' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DeviceConnector" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationDeviceConnectorByMoid": { "operationId": "GetPartnerintegrationDeviceConnectorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/DeviceConnectors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.DeviceConnector' resource.", "operationId": "UpdatePartnerintegrationDeviceConnector", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.DeviceConnector" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.DeviceConnector' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DeviceConnector" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.DeviceConnector' resource was modified as requested. The 'partnerintegration.DeviceConnector' 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/partnerintegration.DeviceConnector" } } }, "links": { "GetPartnerintegrationDeviceConnectorByMoid": { "operationId": "GetPartnerintegrationDeviceConnectorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/DeviceConnectors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.DeviceConnector' resource.", "operationId": "PatchPartnerintegrationDeviceConnector", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.DeviceConnector" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.DeviceConnector' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DeviceConnector" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.DeviceConnector' resource was patched as requested. The 'partnerintegration.DeviceConnector' 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/partnerintegration.DeviceConnector" } } }, "links": { "GetPartnerintegrationDeviceConnectorByMoid": { "operationId": "GetPartnerintegrationDeviceConnectorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/DeviceConnectors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Delete a 'partnerintegration.DeviceConnector' resource.", "operationId": "DeletePartnerintegrationDeviceConnector", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.partnerintegration.DeviceConnector", "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/partnerintegration/DocIssues": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.DocIssues' resource.", "operationId": "GetPartnerintegrationDocIssuesList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.DocIssues", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'partnerintegration.DocIssues' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DocIssues.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/DocIssues/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.DocIssues' resource.", "operationId": "GetPartnerintegrationDocIssuesByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.DocIssues", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'partnerintegration.DocIssues' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.DocIssues" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationDocIssuesByMoid": { "operationId": "GetPartnerintegrationDocIssuesByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/DocIssues/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/Etls": { "post": { "tags": [ "partnerintegration" ], "summary": "Create a 'partnerintegration.Etl' resource.", "operationId": "CreatePartnerintegrationEtl", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.partnerintegration.Etl", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'partnerintegration.Etl' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Etl" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Etl' resource was created as requested. The 'partnerintegration.Etl' 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/partnerintegration.Etl" } } }, "links": { "GetPartnerintegrationEtlByMoid": { "operationId": "GetPartnerintegrationEtlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Etls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Etl' resource.", "operationId": "GetPartnerintegrationEtlList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Etl", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'partnerintegration.Etl' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Etl.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/Etls/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Etl' resource.", "operationId": "GetPartnerintegrationEtlByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Etl", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'partnerintegration.Etl' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Etl" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationEtlByMoid": { "operationId": "GetPartnerintegrationEtlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Etls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.Etl' resource.", "operationId": "UpdatePartnerintegrationEtl", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.Etl" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.Etl' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Etl" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Etl' resource was modified as requested. The 'partnerintegration.Etl' 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/partnerintegration.Etl" } } }, "links": { "GetPartnerintegrationEtlByMoid": { "operationId": "GetPartnerintegrationEtlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Etls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.Etl' resource.", "operationId": "PatchPartnerintegrationEtl", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.Etl" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.Etl' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Etl" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Etl' resource was patched as requested. The 'partnerintegration.Etl' 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/partnerintegration.Etl" } } }, "links": { "GetPartnerintegrationEtlByMoid": { "operationId": "GetPartnerintegrationEtlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Etls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Delete a 'partnerintegration.Etl' resource.", "operationId": "DeletePartnerintegrationEtl", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.partnerintegration.Etl", "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/partnerintegration/Files": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.File' resource.", "operationId": "GetPartnerintegrationFileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.partnerintegration.File", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'partnerintegration.File' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.File.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Create a 'partnerintegration.File' resource.", "operationId": "CreatePartnerintegrationFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.partnerintegration.File", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'partnerintegration.File' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.File" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.File' resource was created as requested. The 'partnerintegration.File' 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/partnerintegration.File" } } }, "links": { "GetPartnerintegrationFileByMoid": { "operationId": "GetPartnerintegrationFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Files/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/Files/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.File' resource.", "operationId": "GetPartnerintegrationFileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.partnerintegration.File", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'partnerintegration.File' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.File" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationFileByMoid": { "operationId": "GetPartnerintegrationFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Files/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.File' resource.", "operationId": "UpdatePartnerintegrationFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.partnerintegration.File" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.File' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.File" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.File' resource was modified as requested. The 'partnerintegration.File' 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/partnerintegration.File" } } }, "links": { "GetPartnerintegrationFileByMoid": { "operationId": "GetPartnerintegrationFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Files/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.File' resource.", "operationId": "PatchPartnerintegrationFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.partnerintegration.File" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.File' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.File" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.File' resource was patched as requested. The 'partnerintegration.File' 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/partnerintegration.File" } } }, "links": { "GetPartnerintegrationFileByMoid": { "operationId": "GetPartnerintegrationFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Files/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Delete a 'partnerintegration.File' resource.", "operationId": "DeletePartnerintegrationFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.partnerintegration.File", "PRIVSET.Account Administrator", "PRIVSET.Manage Workflow Definitions", "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/partnerintegration/Inventories": { "post": { "tags": [ "partnerintegration" ], "summary": "Create a 'partnerintegration.Inventory' resource.", "operationId": "CreatePartnerintegrationInventory", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.partnerintegration.Inventory", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'partnerintegration.Inventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Inventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Inventory' resource was created as requested. The 'partnerintegration.Inventory' 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/partnerintegration.Inventory" } } }, "links": { "GetPartnerintegrationInventoryByMoid": { "operationId": "GetPartnerintegrationInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Inventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Inventory' resource.", "operationId": "GetPartnerintegrationInventoryList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Inventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'partnerintegration.Inventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Inventory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/Inventories/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Inventory' resource.", "operationId": "GetPartnerintegrationInventoryByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Inventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'partnerintegration.Inventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Inventory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationInventoryByMoid": { "operationId": "GetPartnerintegrationInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Inventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.Inventory' resource.", "operationId": "UpdatePartnerintegrationInventory", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.Inventory" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.Inventory' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Inventory" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Inventory' resource was modified as requested. The 'partnerintegration.Inventory' 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/partnerintegration.Inventory" } } }, "links": { "GetPartnerintegrationInventoryByMoid": { "operationId": "GetPartnerintegrationInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Inventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.Inventory' resource.", "operationId": "PatchPartnerintegrationInventory", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.Inventory" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.Inventory' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Inventory" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Inventory' resource was patched as requested. The 'partnerintegration.Inventory' 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/partnerintegration.Inventory" } } }, "links": { "GetPartnerintegrationInventoryByMoid": { "operationId": "GetPartnerintegrationInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Inventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Delete a 'partnerintegration.Inventory' resource.", "operationId": "DeletePartnerintegrationInventory", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.partnerintegration.Inventory", "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/partnerintegration/Logs": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Logs' resource.", "operationId": "GetPartnerintegrationLogsList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Logs", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'partnerintegration.Logs' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Logs.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/Logs/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Logs' resource.", "operationId": "GetPartnerintegrationLogsByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Logs", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'partnerintegration.Logs' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Logs" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationLogsByMoid": { "operationId": "GetPartnerintegrationLogsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Logs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/Metrics": { "post": { "tags": [ "partnerintegration" ], "summary": "Create a 'partnerintegration.Metrics' resource.", "operationId": "CreatePartnerintegrationMetrics", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.partnerintegration.Metrics", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'partnerintegration.Metrics' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Metrics" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Metrics' resource was created as requested. The 'partnerintegration.Metrics' 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/partnerintegration.Metrics" } } }, "links": { "GetPartnerintegrationMetricsByMoid": { "operationId": "GetPartnerintegrationMetricsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Metrics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Metrics' resource.", "operationId": "GetPartnerintegrationMetricsList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Metrics", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'partnerintegration.Metrics' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Metrics.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/Metrics/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Metrics' resource.", "operationId": "GetPartnerintegrationMetricsByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Metrics", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'partnerintegration.Metrics' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Metrics" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationMetricsByMoid": { "operationId": "GetPartnerintegrationMetricsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Metrics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.Metrics' resource.", "operationId": "UpdatePartnerintegrationMetrics", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.Metrics" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.Metrics' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Metrics" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Metrics' resource was modified as requested. The 'partnerintegration.Metrics' 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/partnerintegration.Metrics" } } }, "links": { "GetPartnerintegrationMetricsByMoid": { "operationId": "GetPartnerintegrationMetricsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Metrics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.Metrics' resource.", "operationId": "PatchPartnerintegrationMetrics", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.Metrics" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.Metrics' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Metrics" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Metrics' resource was patched as requested. The 'partnerintegration.Metrics' 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/partnerintegration.Metrics" } } }, "links": { "GetPartnerintegrationMetricsByMoid": { "operationId": "GetPartnerintegrationMetricsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Metrics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Delete a 'partnerintegration.Metrics' resource.", "operationId": "DeletePartnerintegrationMetrics", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.partnerintegration.Metrics", "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/partnerintegration/Models": { "post": { "tags": [ "partnerintegration" ], "summary": "Create a 'partnerintegration.Model' resource.", "operationId": "CreatePartnerintegrationModel", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.partnerintegration.Model", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'partnerintegration.Model' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Model" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Model' resource was created as requested. The 'partnerintegration.Model' 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/partnerintegration.Model" } } }, "links": { "GetPartnerintegrationModelByMoid": { "operationId": "GetPartnerintegrationModelByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Models/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Model' resource.", "operationId": "GetPartnerintegrationModelList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Model", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'partnerintegration.Model' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Model.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/partnerintegration/Models/{Moid}": { "get": { "tags": [ "partnerintegration" ], "summary": "Read a 'partnerintegration.Model' resource.", "operationId": "GetPartnerintegrationModelByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.partnerintegration.Model", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'partnerintegration.Model' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Model" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPartnerintegrationModelByMoid": { "operationId": "GetPartnerintegrationModelByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Models/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.Model' resource.", "operationId": "UpdatePartnerintegrationModel", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.Model" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.Model' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Model" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Model' resource was modified as requested. The 'partnerintegration.Model' 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/partnerintegration.Model" } } }, "links": { "GetPartnerintegrationModelByMoid": { "operationId": "GetPartnerintegrationModelByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Models/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Update a 'partnerintegration.Model' resource.", "operationId": "PatchPartnerintegrationModel", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.partnerintegration.Model" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'partnerintegration.Model' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerintegration.Model" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'partnerintegration.Model' resource was patched as requested. The 'partnerintegration.Model' 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/partnerintegration.Model" } } }, "links": { "GetPartnerintegrationModelByMoid": { "operationId": "GetPartnerintegrationModelByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/partnerintegration/Models/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "partnerintegration" ], "summary": "Delete a 'partnerintegration.Model' resource.", "operationId": "DeletePartnerintegrationModel", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.partnerintegration.Model", "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/pool/IdMappingMembers": { "get": { "tags": [ "pool" ], "summary": "Read a 'pool.IdMappingMember' resource.", "operationId": "GetPoolIdMappingMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.pool.IdMappingMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pool.IdMappingMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pool.IdMappingMember.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pool/IdMappingMembers/{Moid}": { "get": { "tags": [ "pool" ], "summary": "Read a 'pool.IdMappingMember' resource.", "operationId": "GetPoolIdMappingMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.pool.IdMappingMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pool.IdMappingMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pool.IdMappingMember" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPoolIdMappingMemberByMoid": { "operationId": "GetPoolIdMappingMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pool/IdMappingMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pool/IdMappingPolicies": { "get": { "tags": [ "pool" ], "summary": "Read a 'pool.IdMappingPolicy' resource.", "operationId": "GetPoolIdMappingPolicyList", "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.pool.IdMappingPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pool.IdMappingPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pool.IdMappingPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "pool" ], "summary": "Create a 'pool.IdMappingPolicy' resource.", "operationId": "CreatePoolIdMappingPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.pool.IdMappingPolicy", "PRIVSET.Account Administrator", "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 'pool.IdMappingPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pool.IdMappingPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pool.IdMappingPolicy' resource was created as requested. The 'pool.IdMappingPolicy' 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/pool.IdMappingPolicy" } } }, "links": { "GetPoolIdMappingPolicyByMoid": { "operationId": "GetPoolIdMappingPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pool/IdMappingPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pool/IdMappingPolicies/{Moid}": { "get": { "tags": [ "pool" ], "summary": "Read a 'pool.IdMappingPolicy' resource.", "operationId": "GetPoolIdMappingPolicyByMoid", "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.pool.IdMappingPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pool.IdMappingPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pool.IdMappingPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetPoolIdMappingPolicyByMoid": { "operationId": "GetPoolIdMappingPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pool/IdMappingPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "pool" ], "summary": "Update a 'pool.IdMappingPolicy' resource.", "operationId": "UpdatePoolIdMappingPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.pool.IdMappingPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pool.IdMappingPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pool.IdMappingPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pool.IdMappingPolicy' resource was modified as requested. The 'pool.IdMappingPolicy' 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/pool.IdMappingPolicy" } } }, "links": { "GetPoolIdMappingPolicyByMoid": { "operationId": "GetPoolIdMappingPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pool/IdMappingPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "pool" ], "summary": "Update a 'pool.IdMappingPolicy' resource.", "operationId": "PatchPoolIdMappingPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.pool.IdMappingPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pool.IdMappingPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pool.IdMappingPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pool.IdMappingPolicy' resource was patched as requested. The 'pool.IdMappingPolicy' 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/pool.IdMappingPolicy" } } }, "links": { "GetPoolIdMappingPolicyByMoid": { "operationId": "GetPoolIdMappingPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pool/IdMappingPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "pool" ], "summary": "Delete a 'pool.IdMappingPolicy' resource.", "operationId": "DeletePoolIdMappingPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.pool.IdMappingPolicy", "PRIVSET.Account Administrator", "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/recovery/BackupConfigPolicies": { "post": { "tags": [ "recovery" ], "summary": "Create a 'recovery.BackupConfigPolicy' resource.", "operationId": "CreateRecoveryBackupConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.recovery.BackupConfigPolicy", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'recovery.BackupConfigPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupConfigPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.BackupConfigPolicy' resource was created as requested. The 'recovery.BackupConfigPolicy' 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/recovery.BackupConfigPolicy" } } }, "links": { "GetRecoveryBackupConfigPolicyByMoid": { "operationId": "GetRecoveryBackupConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/BackupConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Read a 'recovery.BackupConfigPolicy' resource.", "operationId": "GetRecoveryBackupConfigPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.BackupConfigPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'recovery.BackupConfigPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupConfigPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/BackupConfigPolicies/{Moid}": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.BackupConfigPolicy' resource.", "operationId": "GetRecoveryBackupConfigPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.BackupConfigPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'recovery.BackupConfigPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupConfigPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetRecoveryBackupConfigPolicyByMoid": { "operationId": "GetRecoveryBackupConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/BackupConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Delete a 'recovery.BackupConfigPolicy' resource.", "operationId": "DeleteRecoveryBackupConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.recovery.BackupConfigPolicy", "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" } } }, "post": { "tags": [ "recovery" ], "summary": "Update a 'recovery.BackupConfigPolicy' resource.", "operationId": "UpdateRecoveryBackupConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.recovery.BackupConfigPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'recovery.BackupConfigPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupConfigPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.BackupConfigPolicy' resource was modified as requested. The 'recovery.BackupConfigPolicy' 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/recovery.BackupConfigPolicy" } } }, "links": { "GetRecoveryBackupConfigPolicyByMoid": { "operationId": "GetRecoveryBackupConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/BackupConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Update a 'recovery.BackupConfigPolicy' resource.", "operationId": "PatchRecoveryBackupConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.recovery.BackupConfigPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'recovery.BackupConfigPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupConfigPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.BackupConfigPolicy' resource was patched as requested. The 'recovery.BackupConfigPolicy' 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/recovery.BackupConfigPolicy" } } }, "links": { "GetRecoveryBackupConfigPolicyByMoid": { "operationId": "GetRecoveryBackupConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/BackupConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/BackupProfiles": { "post": { "tags": [ "recovery" ], "summary": "Create a 'recovery.BackupProfile' resource.", "operationId": "CreateRecoveryBackupProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.recovery.BackupProfile", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'recovery.BackupProfile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupProfile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.BackupProfile' resource was created as requested. The 'recovery.BackupProfile' 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/recovery.BackupProfile" } } }, "links": { "GetRecoveryBackupProfileByMoid": { "operationId": "GetRecoveryBackupProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/BackupProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Read a 'recovery.BackupProfile' resource.", "operationId": "GetRecoveryBackupProfileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.BackupProfile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'recovery.BackupProfile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupProfile.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/BackupProfiles/{Moid}": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.BackupProfile' resource.", "operationId": "GetRecoveryBackupProfileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.BackupProfile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'recovery.BackupProfile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupProfile" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetRecoveryBackupProfileByMoid": { "operationId": "GetRecoveryBackupProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/BackupProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Delete a 'recovery.BackupProfile' resource.", "operationId": "DeleteRecoveryBackupProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.recovery.BackupProfile", "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" } } }, "post": { "tags": [ "recovery" ], "summary": "Update a 'recovery.BackupProfile' resource.", "operationId": "UpdateRecoveryBackupProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.recovery.BackupProfile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'recovery.BackupProfile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupProfile" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.BackupProfile' resource was modified as requested. The 'recovery.BackupProfile' 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/recovery.BackupProfile" } } }, "links": { "GetRecoveryBackupProfileByMoid": { "operationId": "GetRecoveryBackupProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/BackupProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Update a 'recovery.BackupProfile' resource.", "operationId": "PatchRecoveryBackupProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.recovery.BackupProfile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'recovery.BackupProfile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.BackupProfile" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.BackupProfile' resource was patched as requested. The 'recovery.BackupProfile' 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/recovery.BackupProfile" } } }, "links": { "GetRecoveryBackupProfileByMoid": { "operationId": "GetRecoveryBackupProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/BackupProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/ConfigResults": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.ConfigResult' resource.", "operationId": "GetRecoveryConfigResultList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.recovery.ConfigResult", "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 'recovery.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/recovery.ConfigResult.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/ConfigResults/{Moid}": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.ConfigResult' resource.", "operationId": "GetRecoveryConfigResultByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.recovery.ConfigResult", "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 'recovery.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/recovery.ConfigResult" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetRecoveryConfigResultByMoid": { "operationId": "GetRecoveryConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/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/recovery/ConfigResultEntries": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.ConfigResultEntry' resource.", "operationId": "GetRecoveryConfigResultEntryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.recovery.ConfigResultEntry", "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 'recovery.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/recovery.ConfigResultEntry.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/ConfigResultEntries/{Moid}": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.ConfigResultEntry' resource.", "operationId": "GetRecoveryConfigResultEntryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.recovery.ConfigResultEntry", "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 'recovery.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/recovery.ConfigResultEntry" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetRecoveryConfigResultEntryByMoid": { "operationId": "GetRecoveryConfigResultEntryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/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/recovery/OnDemandBackups": { "post": { "tags": [ "recovery" ], "summary": "Create a 'recovery.OnDemandBackup' resource.", "operationId": "CreateRecoveryOnDemandBackup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.recovery.OnDemandBackup", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'recovery.OnDemandBackup' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.OnDemandBackup" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.OnDemandBackup' resource was created as requested. The 'recovery.OnDemandBackup' 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/recovery.OnDemandBackup" } } }, "links": { "GetRecoveryOnDemandBackupByMoid": { "operationId": "GetRecoveryOnDemandBackupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/OnDemandBackups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Read a 'recovery.OnDemandBackup' resource.", "operationId": "GetRecoveryOnDemandBackupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.OnDemandBackup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'recovery.OnDemandBackup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.OnDemandBackup.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/OnDemandBackups/{Moid}": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.OnDemandBackup' resource.", "operationId": "GetRecoveryOnDemandBackupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.OnDemandBackup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'recovery.OnDemandBackup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.OnDemandBackup" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetRecoveryOnDemandBackupByMoid": { "operationId": "GetRecoveryOnDemandBackupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/OnDemandBackups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Delete a 'recovery.OnDemandBackup' resource.", "operationId": "DeleteRecoveryOnDemandBackup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.recovery.OnDemandBackup", "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" } } }, "post": { "tags": [ "recovery" ], "summary": "Update a 'recovery.OnDemandBackup' resource.", "operationId": "UpdateRecoveryOnDemandBackup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.recovery.OnDemandBackup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'recovery.OnDemandBackup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.OnDemandBackup" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.OnDemandBackup' resource was modified as requested. The 'recovery.OnDemandBackup' 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/recovery.OnDemandBackup" } } }, "links": { "GetRecoveryOnDemandBackupByMoid": { "operationId": "GetRecoveryOnDemandBackupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/OnDemandBackups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Update a 'recovery.OnDemandBackup' resource.", "operationId": "PatchRecoveryOnDemandBackup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.recovery.OnDemandBackup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'recovery.OnDemandBackup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.OnDemandBackup" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.OnDemandBackup' resource was patched as requested. The 'recovery.OnDemandBackup' 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/recovery.OnDemandBackup" } } }, "links": { "GetRecoveryOnDemandBackupByMoid": { "operationId": "GetRecoveryOnDemandBackupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/OnDemandBackups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/Restores": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.Restore' resource.", "operationId": "GetRecoveryRestoreList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.Restore", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'recovery.Restore' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.Restore.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Create a 'recovery.Restore' resource.", "operationId": "CreateRecoveryRestore", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.recovery.Restore", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'recovery.Restore' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.Restore" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.Restore' resource was created as requested. The 'recovery.Restore' 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/recovery.Restore" } } }, "links": { "GetRecoveryRestoreByMoid": { "operationId": "GetRecoveryRestoreByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/Restores/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/Restores/{Moid}": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.Restore' resource.", "operationId": "GetRecoveryRestoreByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.Restore", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'recovery.Restore' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.Restore" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetRecoveryRestoreByMoid": { "operationId": "GetRecoveryRestoreByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/Restores/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Delete a 'recovery.Restore' resource.", "operationId": "DeleteRecoveryRestore", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.recovery.Restore", "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/recovery/ScheduleConfigPolicies": { "post": { "tags": [ "recovery" ], "summary": "Create a 'recovery.ScheduleConfigPolicy' resource.", "operationId": "CreateRecoveryScheduleConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.recovery.ScheduleConfigPolicy", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'recovery.ScheduleConfigPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.ScheduleConfigPolicy' resource was created as requested. The 'recovery.ScheduleConfigPolicy' 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/recovery.ScheduleConfigPolicy" } } }, "links": { "GetRecoveryScheduleConfigPolicyByMoid": { "operationId": "GetRecoveryScheduleConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/ScheduleConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Read a 'recovery.ScheduleConfigPolicy' resource.", "operationId": "GetRecoveryScheduleConfigPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.ScheduleConfigPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'recovery.ScheduleConfigPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/recovery/ScheduleConfigPolicies/{Moid}": { "get": { "tags": [ "recovery" ], "summary": "Read a 'recovery.ScheduleConfigPolicy' resource.", "operationId": "GetRecoveryScheduleConfigPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.recovery.ScheduleConfigPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'recovery.ScheduleConfigPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetRecoveryScheduleConfigPolicyByMoid": { "operationId": "GetRecoveryScheduleConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/ScheduleConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Delete a 'recovery.ScheduleConfigPolicy' resource.", "operationId": "DeleteRecoveryScheduleConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.recovery.ScheduleConfigPolicy", "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" } } }, "post": { "tags": [ "recovery" ], "summary": "Update a 'recovery.ScheduleConfigPolicy' resource.", "operationId": "UpdateRecoveryScheduleConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.recovery.ScheduleConfigPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'recovery.ScheduleConfigPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.ScheduleConfigPolicy' resource was modified as requested. The 'recovery.ScheduleConfigPolicy' 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/recovery.ScheduleConfigPolicy" } } }, "links": { "GetRecoveryScheduleConfigPolicyByMoid": { "operationId": "GetRecoveryScheduleConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/ScheduleConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "recovery" ], "summary": "Update a 'recovery.ScheduleConfigPolicy' resource.", "operationId": "PatchRecoveryScheduleConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.recovery.ScheduleConfigPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'recovery.ScheduleConfigPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'recovery.ScheduleConfigPolicy' resource was patched as requested. The 'recovery.ScheduleConfigPolicy' 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/recovery.ScheduleConfigPolicy" } } }, "links": { "GetRecoveryScheduleConfigPolicyByMoid": { "operationId": "GetRecoveryScheduleConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/recovery/ScheduleConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Groups": { "post": { "tags": [ "resource" ], "summary": "Create a 'resource.Group' resource.", "operationId": "CreateResourceGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resource.Group", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resource.Group' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Group' resource was created as requested. The 'resource.Group' 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/resource.Group" } } }, "links": { "GetResourceGroupByMoid": { "operationId": "GetResourceGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Groups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "summary": "Read a 'resource.Group' resource.", "operationId": "GetResourceGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.Group", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.Group' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Groups/{Moid}": { "post": { "tags": [ "resource" ], "summary": "Update a 'resource.Group' resource.", "operationId": "UpdateResourceGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.resource.Group" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Group' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Group' resource was modified as requested. The 'resource.Group' 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/resource.Group" } } }, "links": { "GetResourceGroupByMoid": { "operationId": "GetResourceGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Groups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "summary": "Update a 'resource.Group' resource.", "operationId": "PatchResourceGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "ROLE.Account Administrator", "UPDATE.resource.Group" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Group' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Group' resource was patched as requested. The 'resource.Group' 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/resource.Group" } } }, "links": { "GetResourceGroupByMoid": { "operationId": "GetResourceGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Groups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "summary": "Delete a 'resource.Group' resource.", "operationId": "DeleteResourceGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resource.Group", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "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" } } }, "get": { "tags": [ "resource" ], "summary": "Read a 'resource.Group' resource.", "operationId": "GetResourceGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.Group", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.Group' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Group" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourceGroupByMoid": { "operationId": "GetResourceGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Groups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/GroupMembers": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.GroupMember' resource.", "operationId": "GetResourceGroupMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.GroupMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.GroupMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.GroupMember.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/GroupMembers/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.GroupMember' resource.", "operationId": "GetResourceGroupMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.GroupMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.GroupMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.GroupMember" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourceGroupMemberByMoid": { "operationId": "GetResourceGroupMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/GroupMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/LicenseResourceCounts": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.LicenseResourceCount' resource.", "operationId": "GetResourceLicenseResourceCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.resource.LicenseResourceCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.LicenseResourceCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.LicenseResourceCount.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/LicenseResourceCounts/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.LicenseResourceCount' resource.", "operationId": "GetResourceLicenseResourceCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.resource.LicenseResourceCount" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.LicenseResourceCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.LicenseResourceCount" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourceLicenseResourceCountByMoid": { "operationId": "GetResourceLicenseResourceCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/LicenseResourceCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Memberships": { "get": { "tags": [ "resource" ], "x-intersight-type": "SaaS", "summary": "Read a 'resource.Membership' resource.", "operationId": "GetResourceMembershipList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.Membership", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.Membership' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Memberships/{Moid}": { "get": { "tags": [ "resource" ], "x-intersight-type": "SaaS", "summary": "Read a 'resource.Membership' resource.", "operationId": "GetResourceMembershipByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.Membership", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.Membership' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourceMembershipByMoid": { "operationId": "GetResourceMembershipByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Memberships/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "x-intersight-type": "SaaS", "summary": "Update a 'resource.Membership' resource.", "operationId": "UpdateResourceMembership", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.resource.Membership" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Membership' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Membership' resource was modified as requested. The 'resource.Membership' 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/resource.Membership" } } }, "links": { "GetResourceMembershipByMoid": { "operationId": "GetResourceMembershipByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Memberships/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "x-intersight-type": "SaaS", "summary": "Update a 'resource.Membership' resource.", "operationId": "PatchResourceMembership", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.resource.Membership" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Membership' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Membership" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Membership' resource was patched as requested. The 'resource.Membership' 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/resource.Membership" } } }, "links": { "GetResourceMembershipByMoid": { "operationId": "GetResourceMembershipByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/Memberships/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/MembershipHolders": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.MembershipHolder' resource.", "operationId": "GetResourceMembershipHolderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.resource.MembershipHolder" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.MembershipHolder' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.MembershipHolder.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/MembershipHolders/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.MembershipHolder' resource.", "operationId": "GetResourceMembershipHolderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.resource.MembershipHolder" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.MembershipHolder' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.MembershipHolder" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourceMembershipHolderByMoid": { "operationId": "GetResourceMembershipHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/MembershipHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/Reservations": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.Reservation' resource.", "operationId": "GetResourceReservationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Organizations", "READ.resource.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 'resource.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/resource.Reservation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "summary": "Create a 'resource.Reservation' resource.", "operationId": "CreateResourceReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resource.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Claim targets", "PRIVSET.Manage Organizations", "PRIVSET.View Organizations", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resource.Reservation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Reservation' resource was created as requested. The 'resource.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/resource.Reservation" } } }, "links": { "GetResourceReservationByMoid": { "operationId": "GetResourceReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/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/resource/Reservations/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.Reservation' resource.", "operationId": "GetResourceReservationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Organizations", "READ.resource.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 'resource.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/resource.Reservation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourceReservationByMoid": { "operationId": "GetResourceReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/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" } } }, "post": { "tags": [ "resource" ], "summary": "Update a 'resource.Reservation' resource.", "operationId": "UpdateResourceReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim targets", "PRIVSET.Manage Organizations", "PRIVSET.Unclaim targets", "PRIVSET.View Organizations", "ROLE.Account Administrator", "UPDATE.resource.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Reservation' resource was modified as requested. The 'resource.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/resource.Reservation" } } }, "links": { "GetResourceReservationByMoid": { "operationId": "GetResourceReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/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": [ "resource" ], "summary": "Update a 'resource.Reservation' resource.", "operationId": "PatchResourceReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Claim targets", "PRIVSET.Manage Organizations", "PRIVSET.Unclaim targets", "PRIVSET.View Organizations", "ROLE.Account Administrator", "UPDATE.resource.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.Reservation' resource was patched as requested. The 'resource.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/resource.Reservation" } } }, "links": { "GetResourceReservationByMoid": { "operationId": "GetResourceReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/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": [ "resource" ], "summary": "Delete a 'resource.Reservation' resource.", "operationId": "DeleteResourceReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resource.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Manage Organizations", "PRIVSET.Unclaim targets", "PRIVSET.View Organizations", "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/resource/SelectionCriteria": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.SelectionCriteria' resource.", "operationId": "GetResourceSelectionCriteriaList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "READ.resource.SelectionCriteria", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.SelectionCriteria' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "summary": "Create a 'resource.SelectionCriteria' resource.", "operationId": "CreateResourceSelectionCriteria", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resource.SelectionCriteria", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Service Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resource.SelectionCriteria' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.SelectionCriteria' resource was created as requested. The 'resource.SelectionCriteria' 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/resource.SelectionCriteria" } } }, "links": { "GetResourceSelectionCriteriaByMoid": { "operationId": "GetResourceSelectionCriteriaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SelectionCriteria/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/SelectionCriteria/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.SelectionCriteria' resource.", "operationId": "GetResourceSelectionCriteriaByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "READ.resource.SelectionCriteria", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.SelectionCriteria' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourceSelectionCriteriaByMoid": { "operationId": "GetResourceSelectionCriteriaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SelectionCriteria/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "summary": "Update a 'resource.SelectionCriteria' resource.", "operationId": "UpdateResourceSelectionCriteria", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Service Designer", "UPDATE.resource.SelectionCriteria" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.SelectionCriteria' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.SelectionCriteria' resource was modified as requested. The 'resource.SelectionCriteria' 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/resource.SelectionCriteria" } } }, "links": { "GetResourceSelectionCriteriaByMoid": { "operationId": "GetResourceSelectionCriteriaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SelectionCriteria/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "summary": "Update a 'resource.SelectionCriteria' resource.", "operationId": "PatchResourceSelectionCriteria", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Service Designer", "UPDATE.resource.SelectionCriteria" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resource.SelectionCriteria' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SelectionCriteria" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resource.SelectionCriteria' resource was patched as requested. The 'resource.SelectionCriteria' 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/resource.SelectionCriteria" } } }, "links": { "GetResourceSelectionCriteriaByMoid": { "operationId": "GetResourceSelectionCriteriaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SelectionCriteria/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resource" ], "summary": "Delete a 'resource.SelectionCriteria' resource.", "operationId": "DeleteResourceSelectionCriteria", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resource.SelectionCriteria", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Service Designer", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Service Designer" ] } ], "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/resource/SharedResourcesInfoHolders": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.SharedResourcesInfoHolder' resource.", "operationId": "GetResourceSharedResourcesInfoHolderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.SharedResourcesInfoHolder", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'resource.SharedResourcesInfoHolder' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SharedResourcesInfoHolder.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resource/SharedResourcesInfoHolders/{Moid}": { "get": { "tags": [ "resource" ], "summary": "Read a 'resource.SharedResourcesInfoHolder' resource.", "operationId": "GetResourceSharedResourcesInfoHolderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Organizations", "PRIVSET.Read-Only", "PRIVSET.View Organizations", "READ.resource.SharedResourcesInfoHolder", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'resource.SharedResourcesInfoHolder' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resource.SharedResourcesInfoHolder" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourceSharedResourcesInfoHolderByMoid": { "operationId": "GetResourceSharedResourcesInfoHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resource/SharedResourcesInfoHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/ChassisQualificationPolicies": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.ChassisQualificationPolicy' resource.", "operationId": "GetResourcepoolChassisQualificationPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.resourcepool.ChassisQualificationPolicy", "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 'resourcepool.ChassisQualificationPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.ChassisQualificationPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/ChassisQualificationPolicies/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.ChassisQualificationPolicy' resource.", "operationId": "GetResourcepoolChassisQualificationPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.resourcepool.ChassisQualificationPolicy", "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 'resourcepool.ChassisQualificationPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.ChassisQualificationPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolChassisQualificationPolicyByMoid": { "operationId": "GetResourcepoolChassisQualificationPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/ChassisQualificationPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Delete a 'resourcepool.ChassisQualificationPolicy' resource.", "operationId": "DeleteResourcepoolChassisQualificationPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resourcepool.ChassisQualificationPolicy", "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/resourcepool/Leases": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.Lease' resource.", "operationId": "GetResourcepoolLeaseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.Lease", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.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/resourcepool.Lease.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/Leases/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.Lease' resource.", "operationId": "GetResourcepoolLeaseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.Lease", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.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/resourcepool.Lease" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolLeaseByMoid": { "operationId": "GetResourcepoolLeaseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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": [ "resourcepool" ], "summary": "Delete a 'resourcepool.Lease' resource.", "operationId": "DeleteResourcepoolLease", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resourcepool.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/resourcepool/LeaseResources": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.LeaseResource' resource.", "operationId": "GetResourcepoolLeaseResourceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.LeaseResource", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.LeaseResource' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.LeaseResource.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/LeaseResources/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.LeaseResource' resource.", "operationId": "GetResourcepoolLeaseResourceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.LeaseResource", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.LeaseResource' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.LeaseResource" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolLeaseResourceByMoid": { "operationId": "GetResourcepoolLeaseResourceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/LeaseResources/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/MembershipReservations": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.MembershipReservation' resource.", "operationId": "GetResourcepoolMembershipReservationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.MembershipReservation", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.MembershipReservation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.MembershipReservation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/MembershipReservations/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.MembershipReservation' resource.", "operationId": "GetResourcepoolMembershipReservationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.MembershipReservation", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.MembershipReservation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.MembershipReservation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolMembershipReservationByMoid": { "operationId": "GetResourcepoolMembershipReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/MembershipReservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Update a 'resourcepool.MembershipReservation' resource.", "operationId": "UpdateResourcepoolMembershipReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.resourcepool.MembershipReservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resourcepool.MembershipReservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.MembershipReservation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.MembershipReservation' resource was modified as requested. The 'resourcepool.MembershipReservation' 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/resourcepool.MembershipReservation" } } }, "links": { "GetResourcepoolMembershipReservationByMoid": { "operationId": "GetResourcepoolMembershipReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/MembershipReservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Update a 'resourcepool.MembershipReservation' resource.", "operationId": "PatchResourcepoolMembershipReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.resourcepool.MembershipReservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resourcepool.MembershipReservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.MembershipReservation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.MembershipReservation' resource was patched as requested. The 'resourcepool.MembershipReservation' 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/resourcepool.MembershipReservation" } } }, "links": { "GetResourcepoolMembershipReservationByMoid": { "operationId": "GetResourcepoolMembershipReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/MembershipReservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Delete a 'resourcepool.MembershipReservation' resource.", "operationId": "DeleteResourcepoolMembershipReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resourcepool.MembershipReservation", "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/resourcepool/Pools": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.Pool' resource.", "operationId": "GetResourcepoolPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.resourcepool.Pool", "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 'resourcepool.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/resourcepool.Pool.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Create a 'resourcepool.Pool' resource.", "operationId": "CreateResourcepoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resourcepool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Create Resource pools", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resourcepool.Pool' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.Pool" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.Pool' resource was created as requested. The 'resourcepool.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/resourcepool.Pool" } } }, "links": { "GetResourcepoolPoolByMoid": { "operationId": "GetResourcepoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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/resourcepool/Pools/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.Pool' resource.", "operationId": "GetResourcepoolPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.resourcepool.Pool", "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 'resourcepool.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/resourcepool.Pool" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolPoolByMoid": { "operationId": "GetResourcepoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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": [ "resourcepool" ], "summary": "Update a 'resourcepool.Pool' resource.", "operationId": "UpdateResourcepoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Resource pools", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.resourcepool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resourcepool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.Pool' resource was modified as requested. The 'resourcepool.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/resourcepool.Pool" } } }, "links": { "GetResourcepoolPoolByMoid": { "operationId": "GetResourcepoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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": [ "resourcepool" ], "summary": "Update a 'resourcepool.Pool' resource.", "operationId": "PatchResourcepoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Resource pools", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.resourcepool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resourcepool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.Pool' resource was patched as requested. The 'resourcepool.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/resourcepool.Pool" } } }, "links": { "GetResourcepoolPoolByMoid": { "operationId": "GetResourcepoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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": [ "resourcepool" ], "summary": "Delete a 'resourcepool.Pool' resource.", "operationId": "DeleteResourcepoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resourcepool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Delete Resource pools", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain 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/resourcepool/PoolMembers": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.PoolMember' resource.", "operationId": "GetResourcepoolPoolMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.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/resourcepool.PoolMember.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/PoolMembers/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.PoolMember' resource.", "operationId": "GetResourcepoolPoolMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.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/resourcepool.PoolMember" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolPoolMemberByMoid": { "operationId": "GetResourcepoolPoolMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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/resourcepool/QualificationPolicies": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.QualificationPolicy' resource.", "operationId": "GetResourcepoolQualificationPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.resourcepool.QualificationPolicy", "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 'resourcepool.QualificationPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.QualificationPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Create a 'resourcepool.QualificationPolicy' resource.", "operationId": "CreateResourcepoolQualificationPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resourcepool.QualificationPolicy", "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resourcepool.QualificationPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.QualificationPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.QualificationPolicy' resource was created as requested. The 'resourcepool.QualificationPolicy' 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/resourcepool.QualificationPolicy" } } }, "links": { "GetResourcepoolQualificationPolicyByMoid": { "operationId": "GetResourcepoolQualificationPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/QualificationPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/QualificationPolicies/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.QualificationPolicy' resource.", "operationId": "GetResourcepoolQualificationPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.resourcepool.QualificationPolicy", "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 'resourcepool.QualificationPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.QualificationPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolQualificationPolicyByMoid": { "operationId": "GetResourcepoolQualificationPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/QualificationPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Update a 'resourcepool.QualificationPolicy' resource.", "operationId": "UpdateResourcepoolQualificationPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.resourcepool.QualificationPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resourcepool.QualificationPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.QualificationPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.QualificationPolicy' resource was modified as requested. The 'resourcepool.QualificationPolicy' 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/resourcepool.QualificationPolicy" } } }, "links": { "GetResourcepoolQualificationPolicyByMoid": { "operationId": "GetResourcepoolQualificationPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/QualificationPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Update a 'resourcepool.QualificationPolicy' resource.", "operationId": "PatchResourcepoolQualificationPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.resourcepool.QualificationPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resourcepool.QualificationPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.QualificationPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.QualificationPolicy' resource was patched as requested. The 'resourcepool.QualificationPolicy' 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/resourcepool.QualificationPolicy" } } }, "links": { "GetResourcepoolQualificationPolicyByMoid": { "operationId": "GetResourcepoolQualificationPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/QualificationPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Delete a 'resourcepool.QualificationPolicy' resource.", "operationId": "DeleteResourcepoolQualificationPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resourcepool.QualificationPolicy", "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain 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/resourcepool/Reservations": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.Reservation' resource.", "operationId": "GetResourcepoolReservationList", "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.resourcepool.Reservation", "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 'resourcepool.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/resourcepool.Reservation.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "resourcepool" ], "summary": "Create a 'resourcepool.Reservation' resource.", "operationId": "CreateResourcepoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.resourcepool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'resourcepool.Reservation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.Reservation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.Reservation' resource was created as requested. The 'resourcepool.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/resourcepool.Reservation" } } }, "links": { "GetResourcepoolReservationByMoid": { "operationId": "GetResourcepoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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/resourcepool/Reservations/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.Reservation' resource.", "operationId": "GetResourcepoolReservationByMoid", "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.resourcepool.Reservation", "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 'resourcepool.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/resourcepool.Reservation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolReservationByMoid": { "operationId": "GetResourcepoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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" } } }, "post": { "tags": [ "resourcepool" ], "summary": "Update a 'resourcepool.Reservation' resource.", "operationId": "UpdateResourcepoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.resourcepool.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resourcepool.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.Reservation' resource was modified as requested. The 'resourcepool.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/resourcepool.Reservation" } } }, "links": { "GetResourcepoolReservationByMoid": { "operationId": "GetResourcepoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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": [ "resourcepool" ], "summary": "Update a 'resourcepool.Reservation' resource.", "operationId": "PatchResourcepoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain Administrator", "UPDATE.resourcepool.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'resourcepool.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resourcepool.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'resourcepool.Reservation' resource was patched as requested. The 'resourcepool.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/resourcepool.Reservation" } } }, "links": { "GetResourcepoolReservationByMoid": { "operationId": "GetResourcepoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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": [ "resourcepool" ], "summary": "Delete a 'resourcepool.Reservation' resource.", "operationId": "DeleteResourcepoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.resourcepool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "ROLE.UCS Domain 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/resourcepool/Universes": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.Universe' resource.", "operationId": "GetResourcepoolUniverseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.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/resourcepool.Universe.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/resourcepool/Universes/{Moid}": { "get": { "tags": [ "resourcepool" ], "summary": "Read a 'resourcepool.Universe' resource.", "operationId": "GetResourcepoolUniverseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.Server Administrator", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Servers", "READ.resourcepool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Server Administrator", "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 'resourcepool.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/resourcepool.Universe" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetResourcepoolUniverseByMoid": { "operationId": "GetResourcepoolUniverseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/resourcepool/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/rproxy/ReverseProxies": { "post": { "tags": [ "rproxy" ], "x-intersight-type": "SaaS", "summary": "Create a 'rproxy.ReverseProxy' resource.", "operationId": "CreateRproxyReverseProxy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.rproxy.ReverseProxy", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'rproxy.ReverseProxy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rproxy.ReverseProxy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'rproxy.ReverseProxy' resource was created as requested. The 'rproxy.ReverseProxy' 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/rproxy.ReverseProxy" } } }, "links": { "GetRproxyReverseProxyByMoid": { "operationId": "GetRproxyReverseProxyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/rproxy/ReverseProxies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/scheduler/SchedulePolicies": { "get": { "tags": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Read a 'scheduler.SchedulePolicy' resource.", "operationId": "GetSchedulerSchedulePolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.scheduler.SchedulePolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'scheduler.SchedulePolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.SchedulePolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Create a 'scheduler.SchedulePolicy' resource.", "operationId": "CreateSchedulerSchedulePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.scheduler.SchedulePolicy", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'scheduler.SchedulePolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.SchedulePolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'scheduler.SchedulePolicy' resource was created as requested. The 'scheduler.SchedulePolicy' 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/scheduler.SchedulePolicy" } } }, "links": { "GetSchedulerSchedulePolicyByMoid": { "operationId": "GetSchedulerSchedulePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/SchedulePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/scheduler/SchedulePolicies/{Moid}": { "get": { "tags": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Read a 'scheduler.SchedulePolicy' resource.", "operationId": "GetSchedulerSchedulePolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read Workflows", "PRIVSET.Read-Only", "PRIVSET.View Workflow Definitions", "PRIVSET.View Workflow Executions", "READ.scheduler.SchedulePolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'scheduler.SchedulePolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.SchedulePolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSchedulerSchedulePolicyByMoid": { "operationId": "GetSchedulerSchedulePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/SchedulePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Update a 'scheduler.SchedulePolicy' resource.", "operationId": "UpdateSchedulerSchedulePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.scheduler.SchedulePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'scheduler.SchedulePolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.SchedulePolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'scheduler.SchedulePolicy' resource was modified as requested. The 'scheduler.SchedulePolicy' 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/scheduler.SchedulePolicy" } } }, "links": { "GetSchedulerSchedulePolicyByMoid": { "operationId": "GetSchedulerSchedulePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/SchedulePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Update a 'scheduler.SchedulePolicy' resource.", "operationId": "PatchSchedulerSchedulePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.scheduler.SchedulePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'scheduler.SchedulePolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.SchedulePolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'scheduler.SchedulePolicy' resource was patched as requested. The 'scheduler.SchedulePolicy' 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/scheduler.SchedulePolicy" } } }, "links": { "GetSchedulerSchedulePolicyByMoid": { "operationId": "GetSchedulerSchedulePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/SchedulePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Delete a 'scheduler.SchedulePolicy' resource.", "operationId": "DeleteSchedulerSchedulePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.scheduler.SchedulePolicy", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "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/scheduler/TaskResults": { "get": { "tags": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Read a 'scheduler.TaskResult' resource.", "operationId": "GetSchedulerTaskResultList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.scheduler.TaskResult" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'scheduler.TaskResult' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.TaskResult.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/scheduler/TaskResults/{Moid}": { "get": { "tags": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Read a 'scheduler.TaskResult' resource.", "operationId": "GetSchedulerTaskResultByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.scheduler.TaskResult" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'scheduler.TaskResult' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.TaskResult" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSchedulerTaskResultByMoid": { "operationId": "GetSchedulerTaskResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/TaskResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/scheduler/TaskSchedules": { "get": { "tags": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Read a 'scheduler.TaskSchedule' resource.", "operationId": "GetSchedulerTaskScheduleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.scheduler.TaskSchedule" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'scheduler.TaskSchedule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.TaskSchedule.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Create a 'scheduler.TaskSchedule' resource.", "operationId": "CreateSchedulerTaskSchedule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.scheduler.TaskSchedule", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'scheduler.TaskSchedule' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.TaskSchedule" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'scheduler.TaskSchedule' resource was created as requested. The 'scheduler.TaskSchedule' 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/scheduler.TaskSchedule" } } }, "links": { "GetSchedulerTaskScheduleByMoid": { "operationId": "GetSchedulerTaskScheduleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/TaskSchedules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/scheduler/TaskSchedules/{Moid}": { "get": { "tags": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Read a 'scheduler.TaskSchedule' resource.", "operationId": "GetSchedulerTaskScheduleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "READ.scheduler.TaskSchedule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'scheduler.TaskSchedule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.TaskSchedule" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSchedulerTaskScheduleByMoid": { "operationId": "GetSchedulerTaskScheduleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/TaskSchedules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Update a 'scheduler.TaskSchedule' resource.", "operationId": "UpdateSchedulerTaskSchedule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.scheduler.TaskSchedule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'scheduler.TaskSchedule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.TaskSchedule" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'scheduler.TaskSchedule' resource was modified as requested. The 'scheduler.TaskSchedule' 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/scheduler.TaskSchedule" } } }, "links": { "GetSchedulerTaskScheduleByMoid": { "operationId": "GetSchedulerTaskScheduleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/TaskSchedules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Update a 'scheduler.TaskSchedule' resource.", "operationId": "PatchSchedulerTaskSchedule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "ROLE.Account Administrator", "UPDATE.scheduler.TaskSchedule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'scheduler.TaskSchedule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduler.TaskSchedule" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'scheduler.TaskSchedule' resource was patched as requested. The 'scheduler.TaskSchedule' 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/scheduler.TaskSchedule" } } }, "links": { "GetSchedulerTaskScheduleByMoid": { "operationId": "GetSchedulerTaskScheduleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/scheduler/TaskSchedules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "scheduler" ], "x-intersight-type": "SaaS", "summary": "Delete a 'scheduler.TaskSchedule' resource.", "operationId": "DeleteSchedulerTaskSchedule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.scheduler.TaskSchedule", "PRIVSET.Account Administrator", "PRIVSET.Execute Workflows", "PRIVSET.Manage Workflow Definitions", "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/sdaaci/Connections": { "get": { "tags": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Read a 'sdaaci.Connection' resource.", "operationId": "GetSdaaciConnectionList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.sdaaci.Connection", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'sdaaci.Connection' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.Connection.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Create a 'sdaaci.Connection' resource.", "operationId": "CreateSdaaciConnection", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.sdaaci.Connection", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'sdaaci.Connection' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.Connection" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdaaci.Connection' resource was created as requested. The 'sdaaci.Connection' 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/sdaaci.Connection" } } }, "links": { "GetSdaaciConnectionByMoid": { "operationId": "GetSdaaciConnectionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdaaci/Connections/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sdaaci/Connections/{Moid}": { "get": { "tags": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Read a 'sdaaci.Connection' resource.", "operationId": "GetSdaaciConnectionByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.sdaaci.Connection", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'sdaaci.Connection' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.Connection" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSdaaciConnectionByMoid": { "operationId": "GetSdaaciConnectionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdaaci/Connections/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Update a 'sdaaci.Connection' resource.", "operationId": "UpdateSdaaciConnection", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Workflow Designer", "UPDATE.sdaaci.Connection" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'sdaaci.Connection' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.Connection" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdaaci.Connection' resource was modified as requested. The 'sdaaci.Connection' 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/sdaaci.Connection" } } }, "links": { "GetSdaaciConnectionByMoid": { "operationId": "GetSdaaciConnectionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdaaci/Connections/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Update a 'sdaaci.Connection' resource.", "operationId": "PatchSdaaciConnection", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Workflow Designer", "UPDATE.sdaaci.Connection" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'sdaaci.Connection' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.Connection" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdaaci.Connection' resource was patched as requested. The 'sdaaci.Connection' 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/sdaaci.Connection" } } }, "links": { "GetSdaaciConnectionByMoid": { "operationId": "GetSdaaciConnectionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdaaci/Connections/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Delete a 'sdaaci.Connection' resource.", "operationId": "DeleteSdaaciConnection", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.sdaaci.Connection", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Workflow Designer" ] } ], "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/sdaaci/ConnectionDetails": { "get": { "tags": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Read a 'sdaaci.ConnectionDetail' resource.", "operationId": "GetSdaaciConnectionDetailList", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.sdaaci.ConnectionDetail", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'sdaaci.ConnectionDetail' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.ConnectionDetail.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Create a 'sdaaci.ConnectionDetail' resource.", "operationId": "CreateSdaaciConnectionDetail", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.sdaaci.ConnectionDetail", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'sdaaci.ConnectionDetail' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.ConnectionDetail" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdaaci.ConnectionDetail' resource was created as requested. The 'sdaaci.ConnectionDetail' 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/sdaaci.ConnectionDetail" } } }, "links": { "GetSdaaciConnectionDetailByMoid": { "operationId": "GetSdaaciConnectionDetailByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdaaci/ConnectionDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sdaaci/ConnectionDetails/{Moid}": { "get": { "tags": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Read a 'sdaaci.ConnectionDetail' resource.", "operationId": "GetSdaaciConnectionDetailByMoid", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Read-Only", "PRIVSET.Workflow Designer", "READ.sdaaci.ConnectionDetail", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Read-Only", "ROLE.Workflow Designer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'sdaaci.ConnectionDetail' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.ConnectionDetail" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSdaaciConnectionDetailByMoid": { "operationId": "GetSdaaciConnectionDetailByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdaaci/ConnectionDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Update a 'sdaaci.ConnectionDetail' resource.", "operationId": "UpdateSdaaciConnectionDetail", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Workflow Designer", "UPDATE.sdaaci.ConnectionDetail" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'sdaaci.ConnectionDetail' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.ConnectionDetail" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdaaci.ConnectionDetail' resource was modified as requested. The 'sdaaci.ConnectionDetail' 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/sdaaci.ConnectionDetail" } } }, "links": { "GetSdaaciConnectionDetailByMoid": { "operationId": "GetSdaaciConnectionDetailByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdaaci/ConnectionDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Update a 'sdaaci.ConnectionDetail' resource.", "operationId": "PatchSdaaciConnectionDetail", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Workflow Designer", "UPDATE.sdaaci.ConnectionDetail" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'sdaaci.ConnectionDetail' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdaaci.ConnectionDetail" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdaaci.ConnectionDetail' resource was patched as requested. The 'sdaaci.ConnectionDetail' 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/sdaaci.ConnectionDetail" } } }, "links": { "GetSdaaciConnectionDetailByMoid": { "operationId": "GetSdaaciConnectionDetailByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdaaci/ConnectionDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "sdaaci" ], "x-intersight-type": "SaaS", "summary": "Delete a 'sdaaci.ConnectionDetail' resource.", "operationId": "DeleteSdaaciConnectionDetail", "deprecated": true, "x-sunset": "2026-12-20", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.sdaaci.ConnectionDetail", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.Workflow Designer", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.Workflow Designer" ] } ], "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/search/SearchItems": { "get": { "tags": [ "search" ], "summary": "Read a 'search.SearchItem' resource.", "operationId": "GetSearchSearchItemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.search.SearchItem" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'search.SearchItem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search.SearchItem.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/search/SearchItems/{Moid}": { "get": { "tags": [ "search" ], "summary": "Read a 'search.SearchItem' resource.", "operationId": "GetSearchSearchItemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.search.SearchItem" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'search.SearchItem' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search.SearchItem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSearchSearchItemByMoid": { "operationId": "GetSearchSearchItemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/search/SearchItems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/search/TagItems": { "get": { "tags": [ "search" ], "summary": "Read a 'search.TagItem' resource.", "operationId": "GetSearchTagItemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.search.TagItem" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'search.TagItem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search.TagItem.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/search/TagItems/{Moid}": { "get": { "tags": [ "search" ], "summary": "Read a 'search.TagItem' resource.", "operationId": "GetSearchTagItemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global Read Privileges", "PRIVSET.Global System Privileges", "READ.search.TagItem" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'search.TagItem' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/search.TagItem" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSearchTagItemByMoid": { "operationId": "GetSearchTagItemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/search/TagItems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/ApplianceDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.ApplianceDistributable' resource.", "operationId": "GetSoftwareApplianceDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.software.ApplianceDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.ApplianceDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ApplianceDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.ApplianceDistributable' resource.", "operationId": "CreateSoftwareApplianceDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.ApplianceDistributable", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.ApplianceDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ApplianceDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.ApplianceDistributable' resource was created as requested. The 'software.ApplianceDistributable' 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/software.ApplianceDistributable" } } }, "links": { "GetSoftwareApplianceDistributableByMoid": { "operationId": "GetSoftwareApplianceDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/ApplianceDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/ApplianceDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.ApplianceDistributable' resource.", "operationId": "GetSoftwareApplianceDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.software.ApplianceDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.ApplianceDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ApplianceDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareApplianceDistributableByMoid": { "operationId": "GetSoftwareApplianceDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/ApplianceDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.ApplianceDistributable' resource.", "operationId": "UpdateSoftwareApplianceDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.ApplianceDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.ApplianceDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ApplianceDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.ApplianceDistributable' resource was modified as requested. The 'software.ApplianceDistributable' 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/software.ApplianceDistributable" } } }, "links": { "GetSoftwareApplianceDistributableByMoid": { "operationId": "GetSoftwareApplianceDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/ApplianceDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.ApplianceDistributable' resource.", "operationId": "PatchSoftwareApplianceDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.ApplianceDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.ApplianceDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ApplianceDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.ApplianceDistributable' resource was patched as requested. The 'software.ApplianceDistributable' 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/software.ApplianceDistributable" } } }, "links": { "GetSoftwareApplianceDistributableByMoid": { "operationId": "GetSoftwareApplianceDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/ApplianceDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.ApplianceDistributable' resource.", "operationId": "DeleteSoftwareApplianceDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.ApplianceDistributable", "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/software/DownloadHistories": { "get": { "tags": [ "software" ], "summary": "Read a 'software.DownloadHistory' resource.", "operationId": "GetSoftwareDownloadHistoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.software.DownloadHistory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.DownloadHistory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.DownloadHistory.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/DownloadHistories/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.DownloadHistory' resource.", "operationId": "GetSoftwareDownloadHistoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.software.DownloadHistory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.DownloadHistory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.DownloadHistory" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareDownloadHistoryByMoid": { "operationId": "GetSoftwareDownloadHistoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/DownloadHistories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/HciBundleDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HciBundleDistributable' resource.", "operationId": "GetSoftwareHciBundleDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.HciBundleDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.HciBundleDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciBundleDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.HciBundleDistributable' resource.", "operationId": "CreateSoftwareHciBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.HciBundleDistributable", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.HciBundleDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciBundleDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HciBundleDistributable' resource was created as requested. The 'software.HciBundleDistributable' 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/software.HciBundleDistributable" } } }, "links": { "GetSoftwareHciBundleDistributableByMoid": { "operationId": "GetSoftwareHciBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HciBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/HciBundleDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HciBundleDistributable' resource.", "operationId": "GetSoftwareHciBundleDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.HciBundleDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.HciBundleDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciBundleDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareHciBundleDistributableByMoid": { "operationId": "GetSoftwareHciBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HciBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.HciBundleDistributable' resource.", "operationId": "UpdateSoftwareHciBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.HciBundleDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.HciBundleDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciBundleDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HciBundleDistributable' resource was modified as requested. The 'software.HciBundleDistributable' 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/software.HciBundleDistributable" } } }, "links": { "GetSoftwareHciBundleDistributableByMoid": { "operationId": "GetSoftwareHciBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HciBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.HciBundleDistributable' resource.", "operationId": "PatchSoftwareHciBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.HciBundleDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.HciBundleDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciBundleDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HciBundleDistributable' resource was patched as requested. The 'software.HciBundleDistributable' 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/software.HciBundleDistributable" } } }, "links": { "GetSoftwareHciBundleDistributableByMoid": { "operationId": "GetSoftwareHciBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HciBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.HciBundleDistributable' resource.", "operationId": "DeleteSoftwareHciBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.HciBundleDistributable", "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/software/HciDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HciDistributable' resource.", "operationId": "GetSoftwareHciDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.HciDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.HciDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.HciDistributable' resource.", "operationId": "CreateSoftwareHciDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.HciDistributable", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.HciDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HciDistributable' resource was created as requested. The 'software.HciDistributable' 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/software.HciDistributable" } } }, "links": { "GetSoftwareHciDistributableByMoid": { "operationId": "GetSoftwareHciDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HciDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/HciDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HciDistributable' resource.", "operationId": "GetSoftwareHciDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.HciDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.HciDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareHciDistributableByMoid": { "operationId": "GetSoftwareHciDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HciDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.HciDistributable' resource.", "operationId": "UpdateSoftwareHciDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.HciDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.HciDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HciDistributable' resource was modified as requested. The 'software.HciDistributable' 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/software.HciDistributable" } } }, "links": { "GetSoftwareHciDistributableByMoid": { "operationId": "GetSoftwareHciDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HciDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.HciDistributable' resource.", "operationId": "PatchSoftwareHciDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.HciDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.HciDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HciDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HciDistributable' resource was patched as requested. The 'software.HciDistributable' 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/software.HciDistributable" } } }, "links": { "GetSoftwareHciDistributableByMoid": { "operationId": "GetSoftwareHciDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HciDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.HciDistributable' resource.", "operationId": "DeleteSoftwareHciDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.HciDistributable", "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/software/HclMeta": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HclMeta' resource.", "operationId": "GetSoftwareHclMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.software.HclMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.HclMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HclMeta.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/HclMeta/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HclMeta' resource.", "operationId": "GetSoftwareHclMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.software.HclMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.HclMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HclMeta" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareHclMetaByMoid": { "operationId": "GetSoftwareHclMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HclMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/HyperflexBundleDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HyperflexBundleDistributable' resource.", "operationId": "GetSoftwareHyperflexBundleDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.software.HyperflexBundleDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.HyperflexBundleDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexBundleDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.HyperflexBundleDistributable' resource.", "operationId": "CreateSoftwareHyperflexBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.HyperflexBundleDistributable", "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.HyperflexBundleDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexBundleDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HyperflexBundleDistributable' resource was created as requested. The 'software.HyperflexBundleDistributable' 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/software.HyperflexBundleDistributable" } } }, "links": { "GetSoftwareHyperflexBundleDistributableByMoid": { "operationId": "GetSoftwareHyperflexBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HyperflexBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/HyperflexBundleDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HyperflexBundleDistributable' resource.", "operationId": "GetSoftwareHyperflexBundleDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.software.HyperflexBundleDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.HyperflexBundleDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexBundleDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareHyperflexBundleDistributableByMoid": { "operationId": "GetSoftwareHyperflexBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HyperflexBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.HyperflexBundleDistributable' resource.", "operationId": "UpdateSoftwareHyperflexBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "ROLE.Account Administrator", "UPDATE.software.HyperflexBundleDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.HyperflexBundleDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexBundleDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HyperflexBundleDistributable' resource was modified as requested. The 'software.HyperflexBundleDistributable' 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/software.HyperflexBundleDistributable" } } }, "links": { "GetSoftwareHyperflexBundleDistributableByMoid": { "operationId": "GetSoftwareHyperflexBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HyperflexBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.HyperflexBundleDistributable' resource.", "operationId": "PatchSoftwareHyperflexBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "ROLE.Account Administrator", "UPDATE.software.HyperflexBundleDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.HyperflexBundleDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexBundleDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HyperflexBundleDistributable' resource was patched as requested. The 'software.HyperflexBundleDistributable' 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/software.HyperflexBundleDistributable" } } }, "links": { "GetSoftwareHyperflexBundleDistributableByMoid": { "operationId": "GetSoftwareHyperflexBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HyperflexBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.HyperflexBundleDistributable' resource.", "operationId": "DeleteSoftwareHyperflexBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.HyperflexBundleDistributable", "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster 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/software/HyperflexDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HyperflexDistributable' resource.", "operationId": "GetSoftwareHyperflexDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.software.HyperflexDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.HyperflexDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.HyperflexDistributable' resource.", "operationId": "CreateSoftwareHyperflexDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.HyperflexDistributable", "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.HyperflexDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HyperflexDistributable' resource was created as requested. The 'software.HyperflexDistributable' 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/software.HyperflexDistributable" } } }, "links": { "GetSoftwareHyperflexDistributableByMoid": { "operationId": "GetSoftwareHyperflexDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HyperflexDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/HyperflexDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.HyperflexDistributable' resource.", "operationId": "GetSoftwareHyperflexDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex cluster profiles", "PRIVSET.View HyperFlex Cluster Profiles", "READ.software.HyperflexDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.HyperflexDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareHyperflexDistributableByMoid": { "operationId": "GetSoftwareHyperflexDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HyperflexDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.HyperflexDistributable' resource.", "operationId": "UpdateSoftwareHyperflexDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "ROLE.Account Administrator", "UPDATE.software.HyperflexDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.HyperflexDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HyperflexDistributable' resource was modified as requested. The 'software.HyperflexDistributable' 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/software.HyperflexDistributable" } } }, "links": { "GetSoftwareHyperflexDistributableByMoid": { "operationId": "GetSoftwareHyperflexDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HyperflexDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.HyperflexDistributable' resource.", "operationId": "PatchSoftwareHyperflexDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster Profiles", "ROLE.Account Administrator", "UPDATE.software.HyperflexDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.HyperflexDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.HyperflexDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.HyperflexDistributable' resource was patched as requested. The 'software.HyperflexDistributable' 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/software.HyperflexDistributable" } } }, "links": { "GetSoftwareHyperflexDistributableByMoid": { "operationId": "GetSoftwareHyperflexDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/HyperflexDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.HyperflexDistributable' resource.", "operationId": "DeleteSoftwareHyperflexDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.HyperflexDistributable", "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Cluster 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/software/IksBundleDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.IksBundleDistributable' resource.", "operationId": "GetSoftwareIksBundleDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Kubernetes Administrator", "PRIVSET.Kubernetes Operator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.software.IksBundleDistributable", "ROLE.Account Administrator", "ROLE.Kubernetes Administrator", "ROLE.Kubernetes Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.IksBundleDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.IksBundleDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.IksBundleDistributable' resource.", "operationId": "CreateSoftwareIksBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.IksBundleDistributable", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.IksBundleDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.IksBundleDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.IksBundleDistributable' resource was created as requested. The 'software.IksBundleDistributable' 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/software.IksBundleDistributable" } } }, "links": { "GetSoftwareIksBundleDistributableByMoid": { "operationId": "GetSoftwareIksBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/IksBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/IksBundleDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.IksBundleDistributable' resource.", "operationId": "GetSoftwareIksBundleDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Kubernetes Administrator", "PRIVSET.Kubernetes Operator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.software.IksBundleDistributable", "ROLE.Account Administrator", "ROLE.Kubernetes Administrator", "ROLE.Kubernetes Operator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.IksBundleDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.IksBundleDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareIksBundleDistributableByMoid": { "operationId": "GetSoftwareIksBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/IksBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.IksBundleDistributable' resource.", "operationId": "UpdateSoftwareIksBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.IksBundleDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.IksBundleDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.IksBundleDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.IksBundleDistributable' resource was modified as requested. The 'software.IksBundleDistributable' 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/software.IksBundleDistributable" } } }, "links": { "GetSoftwareIksBundleDistributableByMoid": { "operationId": "GetSoftwareIksBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/IksBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.IksBundleDistributable' resource.", "operationId": "PatchSoftwareIksBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.IksBundleDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.IksBundleDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.IksBundleDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.IksBundleDistributable' resource was patched as requested. The 'software.IksBundleDistributable' 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/software.IksBundleDistributable" } } }, "links": { "GetSoftwareIksBundleDistributableByMoid": { "operationId": "GetSoftwareIksBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/IksBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.IksBundleDistributable' resource.", "operationId": "DeleteSoftwareIksBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.IksBundleDistributable", "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/software/ReleaseMeta": { "get": { "tags": [ "software" ], "summary": "Read a 'software.ReleaseMeta' resource.", "operationId": "GetSoftwareReleaseMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "READ.software.ReleaseMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.ReleaseMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ReleaseMeta.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.ReleaseMeta' resource.", "operationId": "CreateSoftwareReleaseMeta", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.ReleaseMeta", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.ReleaseMeta' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ReleaseMeta" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.ReleaseMeta' resource was created as requested. The 'software.ReleaseMeta' 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/software.ReleaseMeta" } } }, "links": { "GetSoftwareReleaseMetaByMoid": { "operationId": "GetSoftwareReleaseMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/ReleaseMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/ReleaseMeta/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.ReleaseMeta' resource.", "operationId": "GetSoftwareReleaseMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "READ.software.ReleaseMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.ReleaseMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ReleaseMeta" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareReleaseMetaByMoid": { "operationId": "GetSoftwareReleaseMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/ReleaseMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.ReleaseMeta' resource.", "operationId": "UpdateSoftwareReleaseMeta", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.ReleaseMeta" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.ReleaseMeta' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ReleaseMeta" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.ReleaseMeta' resource was modified as requested. The 'software.ReleaseMeta' 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/software.ReleaseMeta" } } }, "links": { "GetSoftwareReleaseMetaByMoid": { "operationId": "GetSoftwareReleaseMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/ReleaseMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.ReleaseMeta' resource.", "operationId": "PatchSoftwareReleaseMeta", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.ReleaseMeta" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.ReleaseMeta' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.ReleaseMeta" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.ReleaseMeta' resource was patched as requested. The 'software.ReleaseMeta' 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/software.ReleaseMeta" } } }, "links": { "GetSoftwareReleaseMetaByMoid": { "operationId": "GetSoftwareReleaseMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/ReleaseMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.ReleaseMeta' resource.", "operationId": "DeleteSoftwareReleaseMeta", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.ReleaseMeta", "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/software/SolutionDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.SolutionDistributable' resource.", "operationId": "GetSoftwareSolutionDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.SolutionDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.SolutionDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.SolutionDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.SolutionDistributable' resource.", "operationId": "CreateSoftwareSolutionDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.SolutionDistributable", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.SolutionDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.SolutionDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.SolutionDistributable' resource was created as requested. The 'software.SolutionDistributable' 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/software.SolutionDistributable" } } }, "links": { "GetSoftwareSolutionDistributableByMoid": { "operationId": "GetSoftwareSolutionDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/SolutionDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/SolutionDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.SolutionDistributable' resource.", "operationId": "GetSoftwareSolutionDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.SolutionDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.SolutionDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.SolutionDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareSolutionDistributableByMoid": { "operationId": "GetSoftwareSolutionDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/SolutionDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.SolutionDistributable' resource.", "operationId": "UpdateSoftwareSolutionDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.software.SolutionDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.SolutionDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.SolutionDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.SolutionDistributable' resource was modified as requested. The 'software.SolutionDistributable' 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/software.SolutionDistributable" } } }, "links": { "GetSoftwareSolutionDistributableByMoid": { "operationId": "GetSoftwareSolutionDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/SolutionDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.SolutionDistributable' resource.", "operationId": "PatchSoftwareSolutionDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.software.SolutionDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.SolutionDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.SolutionDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.SolutionDistributable' resource was patched as requested. The 'software.SolutionDistributable' 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/software.SolutionDistributable" } } }, "links": { "GetSoftwareSolutionDistributableByMoid": { "operationId": "GetSoftwareSolutionDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/SolutionDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.SolutionDistributable' resource.", "operationId": "DeleteSoftwareSolutionDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.SolutionDistributable", "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/software/UcsdBundleDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.UcsdBundleDistributable' resource.", "operationId": "GetSoftwareUcsdBundleDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.UcsdBundleDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.UcsdBundleDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdBundleDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.UcsdBundleDistributable' resource.", "operationId": "CreateSoftwareUcsdBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.UcsdBundleDistributable", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.UcsdBundleDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdBundleDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.UcsdBundleDistributable' resource was created as requested. The 'software.UcsdBundleDistributable' 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/software.UcsdBundleDistributable" } } }, "links": { "GetSoftwareUcsdBundleDistributableByMoid": { "operationId": "GetSoftwareUcsdBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/UcsdBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/UcsdBundleDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.UcsdBundleDistributable' resource.", "operationId": "GetSoftwareUcsdBundleDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.UcsdBundleDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.UcsdBundleDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdBundleDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareUcsdBundleDistributableByMoid": { "operationId": "GetSoftwareUcsdBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/UcsdBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.UcsdBundleDistributable' resource.", "operationId": "UpdateSoftwareUcsdBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.UcsdBundleDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.UcsdBundleDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdBundleDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.UcsdBundleDistributable' resource was modified as requested. The 'software.UcsdBundleDistributable' 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/software.UcsdBundleDistributable" } } }, "links": { "GetSoftwareUcsdBundleDistributableByMoid": { "operationId": "GetSoftwareUcsdBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/UcsdBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.UcsdBundleDistributable' resource.", "operationId": "PatchSoftwareUcsdBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.UcsdBundleDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.UcsdBundleDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdBundleDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.UcsdBundleDistributable' resource was patched as requested. The 'software.UcsdBundleDistributable' 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/software.UcsdBundleDistributable" } } }, "links": { "GetSoftwareUcsdBundleDistributableByMoid": { "operationId": "GetSoftwareUcsdBundleDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/UcsdBundleDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.UcsdBundleDistributable' resource.", "operationId": "DeleteSoftwareUcsdBundleDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.UcsdBundleDistributable", "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/software/UcsdDistributables": { "get": { "tags": [ "software" ], "summary": "Read a 'software.UcsdDistributable' resource.", "operationId": "GetSoftwareUcsdDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.UcsdDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'software.UcsdDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdDistributable.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Create a 'software.UcsdDistributable' resource.", "operationId": "CreateSoftwareUcsdDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.software.UcsdDistributable", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'software.UcsdDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.UcsdDistributable' resource was created as requested. The 'software.UcsdDistributable' 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/software.UcsdDistributable" } } }, "links": { "GetSoftwareUcsdDistributableByMoid": { "operationId": "GetSoftwareUcsdDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/UcsdDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/software/UcsdDistributables/{Moid}": { "get": { "tags": [ "software" ], "summary": "Read a 'software.UcsdDistributable' resource.", "operationId": "GetSoftwareUcsdDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.software.UcsdDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'software.UcsdDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdDistributable" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwareUcsdDistributableByMoid": { "operationId": "GetSoftwareUcsdDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/UcsdDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.UcsdDistributable' resource.", "operationId": "UpdateSoftwareUcsdDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.UcsdDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.UcsdDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.UcsdDistributable' resource was modified as requested. The 'software.UcsdDistributable' 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/software.UcsdDistributable" } } }, "links": { "GetSoftwareUcsdDistributableByMoid": { "operationId": "GetSoftwareUcsdDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/UcsdDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Update a 'software.UcsdDistributable' resource.", "operationId": "PatchSoftwareUcsdDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.software.UcsdDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'software.UcsdDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/software.UcsdDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'software.UcsdDistributable' resource was patched as requested. The 'software.UcsdDistributable' 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/software.UcsdDistributable" } } }, "links": { "GetSoftwareUcsdDistributableByMoid": { "operationId": "GetSoftwareUcsdDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/software/UcsdDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "software" ], "summary": "Delete a 'software.UcsdDistributable' resource.", "operationId": "DeleteSoftwareUcsdDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.software.UcsdDistributable", "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/softwarerepository/Authorizations": { "post": { "tags": [ "softwarerepository" ], "summary": "Create a 'softwarerepository.Authorization' resource.", "operationId": "CreateSoftwarerepositoryAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.softwarerepository.Authorization", "PRIVSET.Account Administrator", "PRIVSET.Configure Cisco software download credentials", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'softwarerepository.Authorization' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.Authorization" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.Authorization' resource was created as requested. The 'softwarerepository.Authorization' 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/softwarerepository.Authorization" } } }, "links": { "GetSoftwarerepositoryAuthorizationByMoid": { "operationId": "GetSoftwarerepositoryAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.Authorization' resource.", "operationId": "GetSoftwarerepositoryAuthorizationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Cisco ID", "PRIVSET.Configure Cisco software download credentials", "PRIVSET.Configure MFA", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.softwarerepository.Authorization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.Authorization' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.Authorization.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/Authorizations/{Moid}": { "post": { "tags": [ "softwarerepository" ], "summary": "Update a 'softwarerepository.Authorization' resource.", "operationId": "UpdateSoftwarerepositoryAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.softwarerepository.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'softwarerepository.Authorization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.Authorization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.Authorization' resource was modified as requested. The 'softwarerepository.Authorization' 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/softwarerepository.Authorization" } } }, "links": { "GetSoftwarerepositoryAuthorizationByMoid": { "operationId": "GetSoftwarerepositoryAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "softwarerepository" ], "summary": "Update a 'softwarerepository.Authorization' resource.", "operationId": "PatchSoftwarerepositoryAuthorization", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.softwarerepository.Authorization" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'softwarerepository.Authorization' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.Authorization" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.Authorization' resource was patched as requested. The 'softwarerepository.Authorization' 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/softwarerepository.Authorization" } } }, "links": { "GetSoftwarerepositoryAuthorizationByMoid": { "operationId": "GetSoftwarerepositoryAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.Authorization' resource.", "operationId": "GetSoftwarerepositoryAuthorizationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Cisco ID", "PRIVSET.Configure Cisco software download credentials", "PRIVSET.Configure MFA", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.softwarerepository.Authorization", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.Authorization' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.Authorization" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryAuthorizationByMoid": { "operationId": "GetSoftwarerepositoryAuthorizationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/Authorizations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CachedImages": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CachedImage' resource.", "operationId": "GetSoftwarerepositoryCachedImageList", "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.softwarerepository.CachedImage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.CachedImage' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CachedImage.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CachedImages/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CachedImage' resource.", "operationId": "GetSoftwarerepositoryCachedImageByMoid", "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.softwarerepository.CachedImage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.CachedImage' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CachedImage" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryCachedImageByMoid": { "operationId": "GetSoftwarerepositoryCachedImageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/CachedImages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/Catalogs": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.Catalog' resource.", "operationId": "GetSoftwarerepositoryCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Cluster Profiles", "PRIVSET.View Servers", "READ.softwarerepository.Catalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.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/softwarerepository.Catalog.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/Catalogs/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.Catalog' resource.", "operationId": "GetSoftwarerepositoryCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Cluster Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Cluster Profiles", "PRIVSET.View Servers", "READ.softwarerepository.Catalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.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/softwarerepository.Catalog" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryCatalogByMoid": { "operationId": "GetSoftwarerepositoryCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/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/softwarerepository/CategoryMappers": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CategoryMapper' resource.", "operationId": "GetSoftwarerepositoryCategoryMapperList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.softwarerepository.CategoryMapper", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.CategoryMapper' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CategoryMapper.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CategoryMappers/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CategoryMapper' resource.", "operationId": "GetSoftwarerepositoryCategoryMapperByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.softwarerepository.CategoryMapper", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.CategoryMapper' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CategoryMapper" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryCategoryMapperByMoid": { "operationId": "GetSoftwarerepositoryCategoryMapperByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/CategoryMappers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CategoryMapperModels": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CategoryMapperModel' resource.", "operationId": "GetSoftwarerepositoryCategoryMapperModelList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.softwarerepository.CategoryMapperModel", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.CategoryMapperModel' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CategoryMapperModel.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CategoryMapperModels/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CategoryMapperModel' resource.", "operationId": "GetSoftwarerepositoryCategoryMapperModelByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.softwarerepository.CategoryMapperModel", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.CategoryMapperModel' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CategoryMapperModel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryCategoryMapperModelByMoid": { "operationId": "GetSoftwarerepositoryCategoryMapperModelByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/CategoryMapperModels/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CategorySupportConstraints": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CategorySupportConstraint' resource.", "operationId": "GetSoftwarerepositoryCategorySupportConstraintList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.softwarerepository.CategorySupportConstraint", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.CategorySupportConstraint' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CategorySupportConstraint.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CategorySupportConstraints/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CategorySupportConstraint' resource.", "operationId": "GetSoftwarerepositoryCategorySupportConstraintByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.softwarerepository.CategorySupportConstraint", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.CategorySupportConstraint' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CategorySupportConstraint" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryCategorySupportConstraintByMoid": { "operationId": "GetSoftwarerepositoryCategorySupportConstraintByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/CategorySupportConstraints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CategoryUnsupportedModels": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CategoryUnsupportedModels' resource.", "operationId": "GetSoftwarerepositoryCategoryUnsupportedModelsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.softwarerepository.CategoryUnsupportedModels", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.CategoryUnsupportedModels' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CategoryUnsupportedModels.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/CategoryUnsupportedModels/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.CategoryUnsupportedModels' resource.", "operationId": "GetSoftwarerepositoryCategoryUnsupportedModelsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.softwarerepository.CategoryUnsupportedModels", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.CategoryUnsupportedModels' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.CategoryUnsupportedModels" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryCategoryUnsupportedModelsByMoid": { "operationId": "GetSoftwarerepositoryCategoryUnsupportedModelsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/CategoryUnsupportedModels/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/DownloadSpecs": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.DownloadSpec' resource.", "operationId": "GetSoftwarerepositoryDownloadSpecList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.softwarerepository.DownloadSpec", "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 'softwarerepository.DownloadSpec' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.DownloadSpec.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/DownloadSpecs/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.DownloadSpec' resource.", "operationId": "GetSoftwarerepositoryDownloadSpecByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.softwarerepository.DownloadSpec", "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 'softwarerepository.DownloadSpec' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.DownloadSpec" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryDownloadSpecByMoid": { "operationId": "GetSoftwarerepositoryDownloadSpecByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/DownloadSpecs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/OperatingSystemFiles": { "post": { "tags": [ "softwarerepository" ], "summary": "Create a 'softwarerepository.OperatingSystemFile' resource.", "operationId": "CreateSoftwarerepositoryOperatingSystemFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.softwarerepository.OperatingSystemFile", "PRIVSET.Account Administrator", "PRIVSET.Add OS image links", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'softwarerepository.OperatingSystemFile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.OperatingSystemFile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.OperatingSystemFile' resource was created as requested. The 'softwarerepository.OperatingSystemFile' 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/softwarerepository.OperatingSystemFile" } } }, "links": { "GetSoftwarerepositoryOperatingSystemFileByMoid": { "operationId": "GetSoftwarerepositoryOperatingSystemFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/OperatingSystemFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.OperatingSystemFile' resource.", "operationId": "GetSoftwarerepositoryOperatingSystemFileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS image links", "PRIVSET.Delete OS image links", "PRIVSET.Edit OS image links", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.softwarerepository.OperatingSystemFile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.OperatingSystemFile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.OperatingSystemFile.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/OperatingSystemFiles/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.OperatingSystemFile' resource.", "operationId": "GetSoftwarerepositoryOperatingSystemFileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS image links", "PRIVSET.Delete OS image links", "PRIVSET.Edit OS image links", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.softwarerepository.OperatingSystemFile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.OperatingSystemFile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.OperatingSystemFile" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryOperatingSystemFileByMoid": { "operationId": "GetSoftwarerepositoryOperatingSystemFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/OperatingSystemFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "softwarerepository" ], "summary": "Update a 'softwarerepository.OperatingSystemFile' resource.", "operationId": "UpdateSoftwarerepositoryOperatingSystemFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit OS image links", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.softwarerepository.OperatingSystemFile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'softwarerepository.OperatingSystemFile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.OperatingSystemFile" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.OperatingSystemFile' resource was modified as requested. The 'softwarerepository.OperatingSystemFile' 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/softwarerepository.OperatingSystemFile" } } }, "links": { "GetSoftwarerepositoryOperatingSystemFileByMoid": { "operationId": "GetSoftwarerepositoryOperatingSystemFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/OperatingSystemFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "softwarerepository" ], "summary": "Update a 'softwarerepository.OperatingSystemFile' resource.", "operationId": "PatchSoftwarerepositoryOperatingSystemFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit OS image links", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.softwarerepository.OperatingSystemFile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'softwarerepository.OperatingSystemFile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.OperatingSystemFile" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'softwarerepository.OperatingSystemFile' resource was patched as requested. The 'softwarerepository.OperatingSystemFile' 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/softwarerepository.OperatingSystemFile" } } }, "links": { "GetSoftwarerepositoryOperatingSystemFileByMoid": { "operationId": "GetSoftwarerepositoryOperatingSystemFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/OperatingSystemFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "softwarerepository" ], "summary": "Delete a 'softwarerepository.OperatingSystemFile' resource.", "operationId": "DeleteSoftwarerepositoryOperatingSystemFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.softwarerepository.OperatingSystemFile", "PRIVSET.Account Administrator", "PRIVSET.Delete OS image 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/softwarerepository/Releases": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.Release' resource.", "operationId": "GetSoftwarerepositoryReleaseList", "deprecated": true, "x-sunset": "2027-03-01", "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.Read-only servers", "PRIVSET.Read-only software repository", "READ.softwarerepository.Release", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'softwarerepository.Release' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.Release.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/softwarerepository/Releases/{Moid}": { "get": { "tags": [ "softwarerepository" ], "summary": "Read a 'softwarerepository.Release' resource.", "operationId": "GetSoftwarerepositoryReleaseByMoid", "deprecated": true, "x-sunset": "2027-03-01", "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.Read-only servers", "PRIVSET.Read-only software repository", "READ.softwarerepository.Release", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'softwarerepository.Release' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/softwarerepository.Release" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetSoftwarerepositoryReleaseByMoid": { "operationId": "GetSoftwarerepositoryReleaseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/softwarerepository/Releases/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/CatalystSdwanScopedInventories": { "post": { "tags": [ "task" ], "x-intersight-type": "SaaS", "summary": "Create a 'task.CatalystSdwanScopedInventory' resource.", "operationId": "CreateTaskCatalystSdwanScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.CatalystSdwanScopedInventory", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.CatalystSdwanScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.CatalystSdwanScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.CatalystSdwanScopedInventory' resource was created as requested. The 'task.CatalystSdwanScopedInventory' 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/task.CatalystSdwanScopedInventory" } } }, "links": { "GetTaskCatalystSdwanScopedInventoryByMoid": { "operationId": "GetTaskCatalystSdwanScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/CatalystSdwanScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/FabricMosScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.FabricMosScopedInventory' resource.", "operationId": "CreateTaskFabricMosScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.FabricMosScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.SAN Administrator", "ROLE.Account Administrator", "ROLE.SAN Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.FabricMosScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.FabricMosScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.FabricMosScopedInventory' resource was created as requested. The 'task.FabricMosScopedInventory' 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/task.FabricMosScopedInventory" } } }, "links": { "GetTaskFabricMosScopedInventoryByMoid": { "operationId": "GetTaskFabricMosScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/FabricMosScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/HciScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.HciScopedInventory' resource.", "operationId": "CreateTaskHciScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.HciScopedInventory", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.HciScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HciScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.HciScopedInventory' resource was created as requested. The 'task.HciScopedInventory' 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/task.HciScopedInventory" } } }, "links": { "GetTaskHciScopedInventoryByMoid": { "operationId": "GetTaskHciScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/HciScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/HitachiScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.HitachiScopedInventory' resource.", "operationId": "CreateTaskHitachiScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.HitachiScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.HitachiScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HitachiScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.HitachiScopedInventory' resource was created as requested. The 'task.HitachiScopedInventory' 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/task.HitachiScopedInventory" } } }, "links": { "GetTaskHitachiScopedInventoryByMoid": { "operationId": "GetTaskHitachiScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/HitachiScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/HyperFlexManagementScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.HyperFlexManagementScopedInventory' resource.", "operationId": "CreateTaskHyperFlexManagementScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.HyperFlexManagementScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Clusters", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.HyperFlexManagementScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HyperFlexManagementScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.HyperFlexManagementScopedInventory' resource was created as requested. The 'task.HyperFlexManagementScopedInventory' 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/task.HyperFlexManagementScopedInventory" } } }, "links": { "GetTaskHyperFlexManagementScopedInventoryByMoid": { "operationId": "GetTaskHyperFlexManagementScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/HyperFlexManagementScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/HyperflexScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.HyperflexScopedInventory' resource.", "operationId": "CreateTaskHyperflexScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.HyperflexScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage HyperFlex Clusters", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.HyperflexScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.HyperflexScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.HyperflexScopedInventory' resource was created as requested. The 'task.HyperflexScopedInventory' 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/task.HyperflexScopedInventory" } } }, "links": { "GetTaskHyperflexScopedInventoryByMoid": { "operationId": "GetTaskHyperflexScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/HyperflexScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/MdsScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.MdsScopedInventory' resource.", "operationId": "CreateTaskMdsScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.MdsScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.SAN Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.SAN Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.MdsScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MdsScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.MdsScopedInventory' resource was created as requested. The 'task.MdsScopedInventory' 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/task.MdsScopedInventory" } } }, "links": { "GetTaskMdsScopedInventoryByMoid": { "operationId": "GetTaskMdsScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/MdsScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/MdsSystemScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.MdsSystemScopedInventory' resource.", "operationId": "CreateTaskMdsSystemScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.MdsSystemScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "PRIVSET.SAN Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator", "ROLE.SAN Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.MdsSystemScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MdsSystemScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.MdsSystemScopedInventory' resource was created as requested. The 'task.MdsSystemScopedInventory' 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/task.MdsSystemScopedInventory" } } }, "links": { "GetTaskMdsSystemScopedInventoryByMoid": { "operationId": "GetTaskMdsSystemScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/MdsSystemScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/MerakiScopedInventories": { "post": { "tags": [ "task" ], "x-intersight-type": "SaaS", "summary": "Create a 'task.MerakiScopedInventory' resource.", "operationId": "CreateTaskMerakiScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.MerakiScopedInventory", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.MerakiScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.MerakiScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.MerakiScopedInventory' resource was created as requested. The 'task.MerakiScopedInventory' 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/task.MerakiScopedInventory" } } }, "links": { "GetTaskMerakiScopedInventoryByMoid": { "operationId": "GetTaskMerakiScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/MerakiScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/NetAppScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.NetAppScopedInventory' resource.", "operationId": "CreateTaskNetAppScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.NetAppScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.NetAppScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NetAppScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.NetAppScopedInventory' resource was created as requested. The 'task.NetAppScopedInventory' 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/task.NetAppScopedInventory" } } }, "links": { "GetTaskNetAppScopedInventoryByMoid": { "operationId": "GetTaskNetAppScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/NetAppScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/NexusScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.NexusScopedInventory' resource.", "operationId": "CreateTaskNexusScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.NexusScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.NexusScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.NexusScopedInventory' resource was created as requested. The 'task.NexusScopedInventory' 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/task.NexusScopedInventory" } } }, "links": { "GetTaskNexusScopedInventoryByMoid": { "operationId": "GetTaskNexusScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/NexusScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/NexusSystemScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.NexusSystemScopedInventory' resource.", "operationId": "CreateTaskNexusSystemScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.NexusSystemScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.NexusSystemScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusSystemScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.NexusSystemScopedInventory' resource was created as requested. The 'task.NexusSystemScopedInventory' 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/task.NexusSystemScopedInventory" } } }, "links": { "GetTaskNexusSystemScopedInventoryByMoid": { "operationId": "GetTaskNexusSystemScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/NexusSystemScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/NexusVlanScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.NexusVlanScopedInventory' resource.", "operationId": "CreateTaskNexusVlanScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.NexusVlanScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Network Administrator", "ROLE.Account Administrator", "ROLE.Network Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.NexusVlanScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.NexusVlanScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.NexusVlanScopedInventory' resource was created as requested. The 'task.NexusVlanScopedInventory' 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/task.NexusVlanScopedInventory" } } }, "links": { "GetTaskNexusVlanScopedInventoryByMoid": { "operationId": "GetTaskNexusVlanScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/NexusVlanScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/PureFlashBladeScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.PureFlashBladeScopedInventory' resource.", "operationId": "CreateTaskPureFlashBladeScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.PureFlashBladeScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.PureFlashBladeScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.PureFlashBladeScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.PureFlashBladeScopedInventory' resource was created as requested. The 'task.PureFlashBladeScopedInventory' 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/task.PureFlashBladeScopedInventory" } } }, "links": { "GetTaskPureFlashBladeScopedInventoryByMoid": { "operationId": "GetTaskPureFlashBladeScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/PureFlashBladeScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/PureScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.PureScopedInventory' resource.", "operationId": "CreateTaskPureScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.PureScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.PureScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.PureScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.PureScopedInventory' resource was created as requested. The 'task.PureScopedInventory' 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/task.PureScopedInventory" } } }, "links": { "GetTaskPureScopedInventoryByMoid": { "operationId": "GetTaskPureScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/PureScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/task/ServerScopedInventories": { "post": { "tags": [ "task" ], "summary": "Create a 'task.ServerScopedInventory' resource.", "operationId": "CreateTaskServerScopedInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.task.ServerScopedInventory", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'task.ServerScopedInventory' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/task.ServerScopedInventory" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'task.ServerScopedInventory' resource was created as requested. The 'task.ServerScopedInventory' 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/task.ServerScopedInventory" } } }, "links": { "GetTaskServerScopedInventoryByMoid": { "operationId": "GetTaskServerScopedInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/task/ServerScopedInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/techsupportmanagement/CollectionControlPolicies": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.CollectionControlPolicy' resource.", "operationId": "GetTechsupportmanagementCollectionControlPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "READ.techsupportmanagement.CollectionControlPolicy", "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 'techsupportmanagement.CollectionControlPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.CollectionControlPolicy.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "techsupportmanagement" ], "summary": "Create a 'techsupportmanagement.CollectionControlPolicy' resource.", "operationId": "CreateTechsupportmanagementCollectionControlPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.techsupportmanagement.CollectionControlPolicy", "PRIVSET.Account Administrator", "PRIVSET.Allow/disallow tech support bundles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'techsupportmanagement.CollectionControlPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.CollectionControlPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'techsupportmanagement.CollectionControlPolicy' resource was created as requested. The 'techsupportmanagement.CollectionControlPolicy' 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/techsupportmanagement.CollectionControlPolicy" } } }, "links": { "GetTechsupportmanagementCollectionControlPolicyByMoid": { "operationId": "GetTechsupportmanagementCollectionControlPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/CollectionControlPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/techsupportmanagement/CollectionControlPolicies/{Moid}": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.CollectionControlPolicy' resource.", "operationId": "GetTechsupportmanagementCollectionControlPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "READ.techsupportmanagement.CollectionControlPolicy", "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 'techsupportmanagement.CollectionControlPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.CollectionControlPolicy" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetTechsupportmanagementCollectionControlPolicyByMoid": { "operationId": "GetTechsupportmanagementCollectionControlPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/CollectionControlPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "techsupportmanagement" ], "summary": "Update a 'techsupportmanagement.CollectionControlPolicy' resource.", "operationId": "UpdateTechsupportmanagementCollectionControlPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Allow/disallow tech support bundles", "ROLE.Account Administrator", "UPDATE.techsupportmanagement.CollectionControlPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'techsupportmanagement.CollectionControlPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.CollectionControlPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'techsupportmanagement.CollectionControlPolicy' resource was modified as requested. The 'techsupportmanagement.CollectionControlPolicy' 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/techsupportmanagement.CollectionControlPolicy" } } }, "links": { "GetTechsupportmanagementCollectionControlPolicyByMoid": { "operationId": "GetTechsupportmanagementCollectionControlPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/CollectionControlPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "techsupportmanagement" ], "summary": "Update a 'techsupportmanagement.CollectionControlPolicy' resource.", "operationId": "PatchTechsupportmanagementCollectionControlPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Allow/disallow tech support bundles", "ROLE.Account Administrator", "UPDATE.techsupportmanagement.CollectionControlPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'techsupportmanagement.CollectionControlPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.CollectionControlPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'techsupportmanagement.CollectionControlPolicy' resource was patched as requested. The 'techsupportmanagement.CollectionControlPolicy' 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/techsupportmanagement.CollectionControlPolicy" } } }, "links": { "GetTechsupportmanagementCollectionControlPolicyByMoid": { "operationId": "GetTechsupportmanagementCollectionControlPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/CollectionControlPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "techsupportmanagement" ], "summary": "Delete a 'techsupportmanagement.CollectionControlPolicy' resource.", "operationId": "DeleteTechsupportmanagementCollectionControlPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.techsupportmanagement.CollectionControlPolicy", "PRIVSET.Account Administrator", "PRIVSET.Allow/disallow tech support bundles", "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/techsupportmanagement/Downloads": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.Download' resource.", "operationId": "GetTechsupportmanagementDownloadList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "READ.techsupportmanagement.Download", "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 'techsupportmanagement.Download' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.Download.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/techsupportmanagement/Downloads/{Moid}": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.Download' resource.", "operationId": "GetTechsupportmanagementDownloadByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "READ.techsupportmanagement.Download", "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 'techsupportmanagement.Download' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.Download" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetTechsupportmanagementDownloadByMoid": { "operationId": "GetTechsupportmanagementDownloadByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/Downloads/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/techsupportmanagement/EndPoints": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.EndPoint' resource.", "operationId": "GetTechsupportmanagementEndPointList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "READ.techsupportmanagement.EndPoint" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'techsupportmanagement.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/techsupportmanagement.EndPoint.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/techsupportmanagement/EndPoints/{Moid}": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.EndPoint' resource.", "operationId": "GetTechsupportmanagementEndPointByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "READ.techsupportmanagement.EndPoint" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'techsupportmanagement.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/techsupportmanagement.EndPoint" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetTechsupportmanagementEndPointByMoid": { "operationId": "GetTechsupportmanagementEndPointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/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/techsupportmanagement/TechSupportBundles": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.TechSupportBundle' resource.", "operationId": "GetTechsupportmanagementTechSupportBundleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "READ.techsupportmanagement.TechSupportBundle", "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 'techsupportmanagement.TechSupportBundle' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportBundle.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "techsupportmanagement" ], "summary": "Create a 'techsupportmanagement.TechSupportBundle' resource.", "operationId": "CreateTechsupportmanagementTechSupportBundle", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.techsupportmanagement.TechSupportBundle", "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Manage tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'techsupportmanagement.TechSupportBundle' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportBundle" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'techsupportmanagement.TechSupportBundle' resource was created as requested. The 'techsupportmanagement.TechSupportBundle' 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/techsupportmanagement.TechSupportBundle" } } }, "links": { "GetTechsupportmanagementTechSupportBundleByMoid": { "operationId": "GetTechsupportmanagementTechSupportBundleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/TechSupportBundles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/techsupportmanagement/TechSupportBundles/{Moid}": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.TechSupportBundle' resource.", "operationId": "GetTechsupportmanagementTechSupportBundleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "READ.techsupportmanagement.TechSupportBundle", "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 'techsupportmanagement.TechSupportBundle' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportBundle" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetTechsupportmanagementTechSupportBundleByMoid": { "operationId": "GetTechsupportmanagementTechSupportBundleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/TechSupportBundles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "techsupportmanagement" ], "summary": "Delete a 'techsupportmanagement.TechSupportBundle' resource.", "operationId": "DeleteTechsupportmanagementTechSupportBundle", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.techsupportmanagement.TechSupportBundle", "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Manage tech support bundles", "PRIVSET.Servers", "PRIVSET.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/techsupportmanagement/TechSupportStatuses": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.TechSupportStatus' resource.", "operationId": "GetTechsupportmanagementTechSupportStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "READ.techsupportmanagement.TechSupportStatus", "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 'techsupportmanagement.TechSupportStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/techsupportmanagement/TechSupportStatuses/{Moid}": { "get": { "tags": [ "techsupportmanagement" ], "summary": "Read a 'techsupportmanagement.TechSupportStatus' resource.", "operationId": "GetTechsupportmanagementTechSupportStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.HyperFlex Cluster", "PRIVSET.Manage Techsupport Bundles", "PRIVSET.Read-only tech support bundles", "PRIVSET.Servers", "PRIVSET.Unified Edge", "READ.techsupportmanagement.TechSupportStatus", "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 'techsupportmanagement.TechSupportStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetTechsupportmanagementTechSupportStatusByMoid": { "operationId": "GetTechsupportmanagementTechSupportStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/techsupportmanagement/TechSupportStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/top/Systems": { "get": { "tags": [ "top" ], "summary": "Read a 'top.System' resource.", "operationId": "GetTopSystemList", "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.top.System", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'top.System' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top.System.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/top/Systems/{Moid}": { "get": { "tags": [ "top" ], "summary": "Read a 'top.System' resource.", "operationId": "GetTopSystemByMoid", "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.top.System", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'top.System' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top.System" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetTopSystemByMoid": { "operationId": "GetTopSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/top/Systems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "top" ], "summary": "Update a 'top.System' resource.", "operationId": "UpdateTopSystem", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.top.System" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'top.System' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top.System" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'top.System' resource was modified as requested. The 'top.System' 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/top.System" } } }, "links": { "GetTopSystemByMoid": { "operationId": "GetTopSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/top/Systems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "top" ], "summary": "Update a 'top.System' resource.", "operationId": "PatchTopSystem", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.top.System" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'top.System' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/top.System" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'top.System' resource was patched as requested. The 'top.System' 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/top.System" } } }, "links": { "GetTopSystemByMoid": { "operationId": "GetTopSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/top/Systems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/view/HealthStatuses": { "get": { "tags": [ "view" ], "summary": "Read a 'view.HealthStatus' resource.", "operationId": "GetViewHealthStatusList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Read-only servers", "READ.view.HealthStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'view.HealthStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/view.HealthStatus.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/view/HealthStatuses/{Moid}": { "get": { "tags": [ "view" ], "summary": "Read a 'view.HealthStatus' resource.", "operationId": "GetViewHealthStatusByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Read-only servers", "READ.view.HealthStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'view.HealthStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/view.HealthStatus" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetViewHealthStatusByMoid": { "operationId": "GetViewHealthStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/view/HealthStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/view/Servers": { "get": { "tags": [ "view" ], "summary": "Read a 'view.Server' resource.", "operationId": "GetViewServerList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Read-only servers", "READ.view.Server" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'view.Server' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/view.Server.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/view/Servers/{Moid}": { "get": { "tags": [ "view" ], "summary": "Read a 'view.Server' resource.", "operationId": "GetViewServerByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Global System Privileges", "PRIVSET.Read-only servers", "READ.view.Server" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'view.Server' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/view.Server" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetViewServerByMoid": { "operationId": "GetViewServerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/view/Servers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/Blueprints": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.Blueprint' resource.", "operationId": "GetWorkloadBlueprintList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Designer", "PRIVSET.Workload Operator", "READ.workload.Blueprint", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workload.Blueprint' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.Blueprint.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Create a 'workload.Blueprint' resource.", "operationId": "CreateWorkloadBlueprint", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workload.Blueprint", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workload.Blueprint' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.Blueprint" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.Blueprint' resource was created as requested. The 'workload.Blueprint' 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/workload.Blueprint" } } }, "links": { "GetWorkloadBlueprintByMoid": { "operationId": "GetWorkloadBlueprintByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/Blueprints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/Blueprints/{Moid}": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.Blueprint' resource.", "operationId": "GetWorkloadBlueprintByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Designer", "PRIVSET.Workload Operator", "READ.workload.Blueprint", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workload.Blueprint' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.Blueprint" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetWorkloadBlueprintByMoid": { "operationId": "GetWorkloadBlueprintByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/Blueprints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.Blueprint' resource.", "operationId": "UpdateWorkloadBlueprint", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.workload.Blueprint" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.Blueprint' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.Blueprint" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.Blueprint' resource was modified as requested. The 'workload.Blueprint' 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/workload.Blueprint" } } }, "links": { "GetWorkloadBlueprintByMoid": { "operationId": "GetWorkloadBlueprintByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/Blueprints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.Blueprint' resource.", "operationId": "PatchWorkloadBlueprint", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.workload.Blueprint" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.Blueprint' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.Blueprint" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.Blueprint' resource was patched as requested. The 'workload.Blueprint' 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/workload.Blueprint" } } }, "links": { "GetWorkloadBlueprintByMoid": { "operationId": "GetWorkloadBlueprintByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/Blueprints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Delete a 'workload.Blueprint' resource.", "operationId": "DeleteWorkloadBlueprint", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workload.Blueprint", "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/workload/ClearWorkloadTags": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.ClearWorkloadTag' resource.", "operationId": "GetWorkloadClearWorkloadTagList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workload.ClearWorkloadTag", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workload.ClearWorkloadTag' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.ClearWorkloadTag.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Create a 'workload.ClearWorkloadTag' resource.", "operationId": "CreateWorkloadClearWorkloadTag", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workload.ClearWorkloadTag", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workload.ClearWorkloadTag' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.ClearWorkloadTag" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.ClearWorkloadTag' resource was created as requested. The 'workload.ClearWorkloadTag' 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/workload.ClearWorkloadTag" } } }, "links": { "GetWorkloadClearWorkloadTagByMoid": { "operationId": "GetWorkloadClearWorkloadTagByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/ClearWorkloadTags/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/ClearWorkloadTags/{Moid}": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.ClearWorkloadTag' resource.", "operationId": "GetWorkloadClearWorkloadTagByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workload.ClearWorkloadTag", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workload.ClearWorkloadTag' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.ClearWorkloadTag" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetWorkloadClearWorkloadTagByMoid": { "operationId": "GetWorkloadClearWorkloadTagByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/ClearWorkloadTags/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Delete a 'workload.ClearWorkloadTag' resource.", "operationId": "DeleteWorkloadClearWorkloadTag", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workload.ClearWorkloadTag", "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/workload/DeploymentInputs": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.DeploymentInput' resource.", "operationId": "GetWorkloadDeploymentInputList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workload.DeploymentInput", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workload.DeploymentInput' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.DeploymentInput.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/DeploymentInputs/{Moid}": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.DeploymentInput' resource.", "operationId": "GetWorkloadDeploymentInputByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.workload.DeploymentInput", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workload.DeploymentInput' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.DeploymentInput" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetWorkloadDeploymentInputByMoid": { "operationId": "GetWorkloadDeploymentInputByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/DeploymentInputs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/WorkloadDefinitions": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.WorkloadDefinition' resource.", "operationId": "GetWorkloadWorkloadDefinitionList", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Designer", "PRIVSET.Workload Operator", "READ.workload.WorkloadDefinition", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workload.WorkloadDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDefinition.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Create a 'workload.WorkloadDefinition' resource.", "operationId": "CreateWorkloadWorkloadDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workload.WorkloadDefinition", "PRIVSET.Account Administrator", "PRIVSET.Workload Designer", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workload.WorkloadDefinition' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDefinition" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadDefinition' resource was created as requested. The 'workload.WorkloadDefinition' 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/workload.WorkloadDefinition" } } }, "links": { "GetWorkloadWorkloadDefinitionByMoid": { "operationId": "GetWorkloadWorkloadDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/WorkloadDefinitions/{Moid}": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.WorkloadDefinition' resource.", "operationId": "GetWorkloadWorkloadDefinitionByMoid", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Designer", "PRIVSET.Workload Operator", "READ.workload.WorkloadDefinition", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workload.WorkloadDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDefinition" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetWorkloadWorkloadDefinitionByMoid": { "operationId": "GetWorkloadWorkloadDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.WorkloadDefinition' resource.", "operationId": "UpdateWorkloadWorkloadDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Designer", "ROLE.Account Administrator", "UPDATE.workload.WorkloadDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.WorkloadDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadDefinition' resource was modified as requested. The 'workload.WorkloadDefinition' 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/workload.WorkloadDefinition" } } }, "links": { "GetWorkloadWorkloadDefinitionByMoid": { "operationId": "GetWorkloadWorkloadDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.WorkloadDefinition' resource.", "operationId": "PatchWorkloadWorkloadDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Designer", "ROLE.Account Administrator", "UPDATE.workload.WorkloadDefinition" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.WorkloadDefinition' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDefinition" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadDefinition' resource was patched as requested. The 'workload.WorkloadDefinition' 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/workload.WorkloadDefinition" } } }, "links": { "GetWorkloadWorkloadDefinitionByMoid": { "operationId": "GetWorkloadWorkloadDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Delete a 'workload.WorkloadDefinition' resource.", "operationId": "DeleteWorkloadWorkloadDefinition", "x-stability-level": "draft", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workload.WorkloadDefinition", "PRIVSET.Account Administrator", "PRIVSET.Workload Designer", "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/workload/WorkloadDeployments": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.WorkloadDeployment' resource.", "operationId": "GetWorkloadWorkloadDeploymentList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workload Operator", "READ.workload.WorkloadDeployment", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workload.WorkloadDeployment' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDeployment.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Create a 'workload.WorkloadDeployment' resource.", "operationId": "CreateWorkloadWorkloadDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.workload.WorkloadDeployment", "PRIVSET.Account Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'workload.WorkloadDeployment' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDeployment" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadDeployment' resource was created as requested. The 'workload.WorkloadDeployment' 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/workload.WorkloadDeployment" } } }, "links": { "GetWorkloadWorkloadDeploymentByMoid": { "operationId": "GetWorkloadWorkloadDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadDeployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/WorkloadDeployments/{Moid}": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.WorkloadDeployment' resource.", "operationId": "GetWorkloadWorkloadDeploymentByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workload Operator", "READ.workload.WorkloadDeployment", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workload.WorkloadDeployment' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDeployment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetWorkloadWorkloadDeploymentByMoid": { "operationId": "GetWorkloadWorkloadDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadDeployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.WorkloadDeployment' resource.", "operationId": "UpdateWorkloadWorkloadDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Workload Operator", "UPDATE.workload.WorkloadDeployment" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.WorkloadDeployment' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDeployment" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadDeployment' resource was modified as requested. The 'workload.WorkloadDeployment' 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/workload.WorkloadDeployment" } } }, "links": { "GetWorkloadWorkloadDeploymentByMoid": { "operationId": "GetWorkloadWorkloadDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadDeployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.WorkloadDeployment' resource.", "operationId": "PatchWorkloadWorkloadDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Workload Operator", "UPDATE.workload.WorkloadDeployment" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.WorkloadDeployment' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadDeployment" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadDeployment' resource was patched as requested. The 'workload.WorkloadDeployment' 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/workload.WorkloadDeployment" } } }, "links": { "GetWorkloadWorkloadDeploymentByMoid": { "operationId": "GetWorkloadWorkloadDeploymentByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadDeployments/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Delete a 'workload.WorkloadDeployment' resource.", "operationId": "DeleteWorkloadWorkloadDeployment", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workload.WorkloadDeployment", "PRIVSET.Account Administrator", "PRIVSET.Catalog Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Catalog Administrator", "ROLE.Workload Operator" ] } ], "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/workload/WorkloadInstances": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.WorkloadInstance' resource.", "operationId": "GetWorkloadWorkloadInstanceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workload Operator", "READ.workload.WorkloadInstance", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workload.WorkloadInstance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadInstance.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/WorkloadInstances/{Moid}": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.WorkloadInstance' resource.", "operationId": "GetWorkloadWorkloadInstanceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Workload Operator", "READ.workload.WorkloadInstance", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workload.WorkloadInstance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadInstance" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetWorkloadWorkloadInstanceByMoid": { "operationId": "GetWorkloadWorkloadInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Delete a 'workload.WorkloadInstance' resource.", "operationId": "DeleteWorkloadWorkloadInstance", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.workload.WorkloadInstance", "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" } } }, "post": { "tags": [ "workload" ], "summary": "Update a 'workload.WorkloadInstance' resource.", "operationId": "UpdateWorkloadWorkloadInstance", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Workload Operator", "UPDATE.workload.WorkloadInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.WorkloadInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadInstance" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadInstance' resource was modified as requested. The 'workload.WorkloadInstance' 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/workload.WorkloadInstance" } } }, "links": { "GetWorkloadWorkloadInstanceByMoid": { "operationId": "GetWorkloadWorkloadInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.WorkloadInstance' resource.", "operationId": "PatchWorkloadWorkloadInstance", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Operator", "ROLE.Account Administrator", "ROLE.Workload Operator", "UPDATE.workload.WorkloadInstance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.WorkloadInstance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadInstance" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadInstance' resource was patched as requested. The 'workload.WorkloadInstance' 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/workload.WorkloadInstance" } } }, "links": { "GetWorkloadWorkloadInstanceByMoid": { "operationId": "GetWorkloadWorkloadInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/WorkloadMetadata": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.WorkloadMetadata' resource.", "operationId": "GetWorkloadWorkloadMetadataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Designer", "PRIVSET.Workload Operator", "READ.workload.WorkloadMetadata", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'workload.WorkloadMetadata' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadMetadata.Response" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/workload/WorkloadMetadata/{Moid}": { "get": { "tags": [ "workload" ], "summary": "Read a 'workload.WorkloadMetadata' resource.", "operationId": "GetWorkloadWorkloadMetadataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Service Designer", "PRIVSET.Service Operator", "PRIVSET.Workload Designer", "PRIVSET.Workload Operator", "READ.workload.WorkloadMetadata", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.Service Designer", "ROLE.Service Operator", "ROLE.Workload Operator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'workload.WorkloadMetadata' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadMetadata" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "#/components/schemas/ExcelFile" } } }, "links": { "GetWorkloadWorkloadMetadataByMoid": { "operationId": "GetWorkloadWorkloadMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.WorkloadMetadata' resource.", "operationId": "UpdateWorkloadWorkloadMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Designer", "ROLE.Account Administrator", "UPDATE.workload.WorkloadMetadata" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.WorkloadMetadata' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadMetadata" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadMetadata' resource was modified as requested. The 'workload.WorkloadMetadata' 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/workload.WorkloadMetadata" } } }, "links": { "GetWorkloadWorkloadMetadataByMoid": { "operationId": "GetWorkloadWorkloadMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": [ "workload" ], "summary": "Update a 'workload.WorkloadMetadata' resource.", "operationId": "PatchWorkloadWorkloadMetadata", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Workload Designer", "ROLE.Account Administrator", "UPDATE.workload.WorkloadMetadata" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'workload.WorkloadMetadata' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/workload.WorkloadMetadata" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'workload.WorkloadMetadata' resource was patched as requested. The 'workload.WorkloadMetadata' 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/workload.WorkloadMetadata" } } }, "links": { "GetWorkloadWorkloadMetadataByMoid": { "operationId": "GetWorkloadWorkloadMetadataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/workload/WorkloadMetadata/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/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": { "telemetry.DruidBaseRequest": { "type": "object", "description": "The base structure for all Druid requests.", "required": [ "queryType" ], "properties": { "queryType": { "description": "The type of druid query.", "type": "string", "enum": [ "timeseries", "topN", "groupBy", "scan", "timeBoundary", "segmentMetadata", "dataSourceMetadata", "search" ] } } }, "telemetry.DruidError": { "description": "The error response when a Druid query fails.", "type": "object", "properties": { "error": { "description": "A well-defined error code.", "type": "string" }, "errorMessage": { "description": "A free-form message with more information about the error. May be null.", "type": "string" }, "errorClass": { "description": "The class of the exception that caused this error. May be null." } } }, "telemetry.DruidIntervalResult": { "description": "The time series results for a particular interval", "type": "object", "properties": { "timestamp": { "description": "The ISO 8601 timestamp.", "type": "string", "format": "date-time" }, "result": { "description": "A map of output field names to metric values (long or double).", "type": "object" } } }, "telemetry.DruidTopNResult": { "description": "Sorted time series results for a particular interval based on some criteria", "type": "object", "properties": { "timestamp": { "description": "The ISO 8601 timestamp.", "type": "string", "format": "date-time" }, "result": { "description": "A sorted list of dimension values", "type": "array", "items": { "description": "A dimension value matching criteria", "type": "object" } } } }, "telemetry.DruidGroupByResult": { "description": "A time series result based on a provided groupBy query. Result can contain multiple dimensions and values.", "type": "object", "properties": { "timestamp": { "description": "The ISO 8601 timestamp.", "type": "string", "format": "date-time" }, "version": { "description": "The version of the Druid GroupBy Engine used in query.", "type": "string" }, "event": { "description": "Grouped aggregate dimension(s) with values.", "type": "object" } } }, "telemetry.DruidScanResult": { "description": "Druid Scan row result.", "type": "object", "properties": { "segmentId": { "description": "The identifier for the row(s)' segment.", "type": "string" }, "columns": { "description": "A list of columns returned in the row(s).", "type": "array", "items": { "description": "A column name.", "type": "string" } }, "events": { "description": "Row results.", "type": "array", "items": { "description": "A scan row result. If the formatResult is 'list', the value is an object. If the formatResult is 'compactedList, the value is an array that contains dimension or metrics value. A dimension may be a string, number, array, object, or the null value. Metrics are numbers (float or integer)." } } } }, "telemetry.DruidSearchResult": { "description": "Dimension value matching the search query.", "type": "object", "properties": { "timestamp": { "description": "The ISO 8601 timestamp.", "type": "string", "format": "date-time" }, "result": { "description": "A list of dimension values", "type": "array", "items": { "description": "A dimension value matching search query", "type": "object" } } } }, "telemetry.DruidTimeBoundaryResult": { "description": "The earliest and latest timestamps for a dataset", "type": "object", "properties": { "timestamp": { "description": "The ISO 8601 timestamp.", "type": "string", "format": "date-time" }, "result": { "description": "The corresponding timestamps for query. May contain maxTime, minTime, or both (default).", "type": "object" } } }, "telemetry.DruidSegmentMetadataResult": { "description": "Metadata about a Druid segment", "type": "object", "properties": { "id": { "description": "An identifier for the metadata", "type": "string" }, "intervals": { "description": "String representation of the interval queried", "type": "string" }, "columns": { "description": "A map of columns and their properties", "type": "object" }, "aggregators": { "description": "A map of metrics and their properties", "type": "object" }, "queryGranularity": { "description": "query granularity of data stored in segments, may be 'null'", "type": "object" }, "size": { "description": "estimated total segment byte size as if stored as text", "type": "integer" }, "numRows": { "description": "number of rows stored in segment", "type": "integer" } } }, "telemetry.DruidDataSourceMetadataResult": { "description": "Metadata about a Druid datasource", "type": "object", "properties": { "timestamp": { "description": "The ISO 8601 timestamp.", "type": "string", "format": "date-time" }, "result": { "description": "The metadata for the specified datasource", "type": "object" } } }, "telemetry.DruidBaseGranularity": { "type": "object", "description": "The base structure for a Druid granularity.", "required": [ "type" ], "properties": { "type": { "description": "the type of granularity.", "type": "string", "enum": [ "duration", "period" ] } } }, "telemetry.DruidGranularity": { "description": "The granularity field determines how data gets bucketed across the time dimension,\nor how it gets aggregated by hour, day, minute, etc.\nIt can be specified either as a string for simple granularities or as an object for arbitrary granularities.\nSee [Granularities](https://druid.apache.org/docs/latest/querying/granularities.html).", "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidDurationGranularity" }, { "$ref": "#/components/schemas/telemetry.DruidPeriodGranularity" } ], "discriminator": { "propertyName": "type", "mapping": { "duration": "#/components/schemas/telemetry.DruidDurationGranularity", "period": "#/components/schemas/telemetry.DruidPeriodGranularity" } } }, "telemetry.DruidDurationGranularity": { "description": "Duration granularities are specified as an exact duration in milliseconds and timestamps are returned as UTC.\nDuration granularity values are in milliseconds.\nThey also support specifying an optional origin, which defines where to start counting\ntime buckets from (defaults to 1970-01-01T00:00:00Z).", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseGranularity" }, { "type": "object", "required": [ "duration" ], "properties": { "duration": { "description": "The duration in milliseconds.", "type": "integer", "format": "int64" }, "origin": { "description": "An optional value specifying when to start counting time buckets from.\nThe default value is 1970-01-01T00:00:00Z.", "type": "string", "format": "date-time" } } } ] }, "telemetry.DruidPeriodGranularity": { "description": "Period granularities are specified as arbitrary period combinations of years, months, weeks, hours,\nminutes and seconds (e.g., P2W, P3M, PT1H30M, PT0.750S) in ISO8601 format.\nThey support specifying a time zone which determines where period boundaries start as well as the\ntimezone of the returned timestamps. By default, years start on the first of January, months start\non the first of the month and weeks start on Mondays unless an origin is specified.\nTime zone is optional (defaults to UTC). Origin is optional (defaults to 1970-01-01T00:00:00 in the given time zone).", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseGranularity" }, { "type": "object", "required": [ "period" ], "properties": { "period": { "description": "The period in ISO 8601 format. Examples are P2W, P3M, PT1H30M, PT0.750S.", "type": "string" }, "timeZone": { "description": "An optional value specifying the time zone. Standard [IANA time zones](http://joda-time.sourceforge.net/timezones.html) are supported.", "type": "string" } } } ] }, "telemetry.DruidBaseDataSource": { "description": "A data source is the Apache Druid equivalent of a database table. However, a query can also\nmasquerade as a data source, providing subquery-like functionality. Query data sources are\ncurrently supported only by GroupBy queries.", "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The type of data source.", "type": "string", "enum": [ "table", "union", "query" ] } } }, "telemetry.DruidDataSource": { "description": "A data source is the Apache Druid equivalent of a database table. However, a query can also\nmasquerade as a data source, providing subquery-like functionality. Query data sources are\ncurrently supported only by GroupBy queries.", "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidTableDataSource" }, { "$ref": "#/components/schemas/telemetry.DruidUnionDataSource" }, { "$ref": "#/components/schemas/telemetry.DruidQueryDataSource" }, { "$ref": "#/components/schemas/telemetry.DruidLookupDataSource" }, { "$ref": "#/components/schemas/telemetry.DruidJoinDataSource" }, { "$ref": "#/components/schemas/telemetry.DruidInlineDataSource" } ], "discriminator": { "propertyName": "type", "mapping": { "table": "#/components/schemas/telemetry.DruidTableDataSource", "union": "#/components/schemas/telemetry.DruidUnionDataSource", "query": "#/components/schemas/telemetry.DruidQueryDataSource", "lookup": "#/components/schemas/telemetry.DruidLookupDataSource", "join": "#/components/schemas/telemetry.DruidJoinDataSource", "scan": "#/components/schemas/telemetry.DruidInlineDataSource" } } }, "telemetry.DruidTableDataSource": { "description": "The table data source is the most common datasource type. They are split up into segments, distributed around the cluster, and queried in parallel.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseDataSource" }, { "type": "object", "required": [ "name" ], "properties": { "name": { "description": "The name of a data source.", "type": "string" } } } ] }, "telemetry.DruidUnionDataSource": { "description": "This data source unions two or more table data sources. Note that the data sources being unioned should have the same schema.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseDataSource" }, { "type": "object", "required": [ "dataSources" ], "properties": { "dataSources": { "description": "A list of data sources.", "type": "array", "items": { "description": "The name of a data source.", "type": "string" } } } } ] }, "telemetry.DruidQueryDataSource": { "description": "This is used for nested groupBys and is only currently supported for groupBys.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseDataSource" }, { "type": "object", "required": [ "query" ], "properties": { "query": { "$ref": "#/components/schemas/telemetry.DruidGroupByRequest" } } } ] }, "telemetry.DruidLookupDataSource": { "description": "Lookup datasources correspond to Druid's key-value lookup objects. In Druid SQL, they reside in the the lookup schema. They are preloaded in memory on all servers, so they can be accessed rapidly. They can be joined onto regular tables using the join operator. Lookup datasources are key-value oriented and always have exactly two columns, k (the key) and v (the value), and both are always strings. Lookups can be joined with a base table either using an explicit join, or by using the SQL LOOKUP function. However, the join operator must evaluate the condition on each row, whereas the LOOKUP function can defer evaluation until after an aggregation phase. This means that the LOOKUP function is usually faster than joining to a lookup datasource.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseDataSource" }, { "type": "object", "required": [ "lookup" ], "properties": { "lookup": { "description": "the name of the lookup object.", "type": "string" } } } ] }, "telemetry.DruidInlineDataSource": { "description": "Inline datasources allow you to query a small amount of data that is embedded in the query itself. They are useful when you want to write a query on a small amount of data without loading it first. They are also useful as inputs into a join. Druid also uses them internally to handle subqueries that need to be inlined on the Broker. There are two fields in an inline datasource, an array of columnNames and an array of rows. Each row is an array that must be exactly as long as the list of columnNames. The first element in each row corresponds to the first column in columnNames, and so on.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseDataSource" }, { "type": "object", "required": [ "columnNames", "rows" ], "properties": { "columnNames": { "description": "the column names.", "type": "array", "items": { "description": "the name of a column.", "type": "string" } }, "rows": { "description": "an array of rows.", "type": "array", "items": { "description": "a row. Each row is an array that must be exactly as long as the list of columnNames.", "type": "array", "items": { "description": "a column/row cell value.", "type": "string" } } } } } ] }, "telemetry.DruidJoinDataSource": { "description": "Join datasources allow you to do a SQL-style join of two datasources. Stacking joins on top of each other allows you to join arbitrarily many datasources. Joins are implemented with a broadcast hash-join algorithm. This means that all tables other than the leftmost \"base\" table must fit in memory. It also means that the join condition must be an equality. This feature is intended mainly to allow joining regular Druid tables with lookup, inline, and query datasources.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseDataSource" }, { "type": "object", "required": [ "left", "right", "rightPrefix", "condition", "joinType" ], "properties": { "left": { "description": "Left-hand datasource. Must be of type table, join, lookup, query, or inline. Placing another join as the left datasource allows you to join arbitrarily many datasources.", "type": "string" }, "right": { "description": "Right-hand datasource. Must be of type lookup, query, or inline.", "type": "string" }, "rightPrefix": { "description": "String prefix that will be applied to all columns from the right-hand datasource, to prevent them from colliding with columns from the left-hand datasource. Can be any string, so long as it is nonempty and is not be a prefix of the string __time. Any columns from the left-hand side that start with your rightPrefix will be shadowed. It is up to you to provide a prefix that will not shadow any important columns from the left side.", "type": "string" }, "condition": { "description": "Expression that must be an equality where one side is an expression of the left-hand side, and the other side is a simple column reference to the right-hand side. The right-hand reference must be a simple column reference.", "type": "string" }, "joinType": { "type": "string", "enum": [ "INNER", "LEFT" ] } } } ] }, "telemetry.DruidBaseTopNMetricSpec": { "description": "A Druid TopN metric spec.", "type": "object", "required": [ "type" ], "properties": { "type": { "description": "The dimension spec type.", "type": "string", "enum": [ "numeric", "dimension", "inverted" ] } } }, "telemetry.DruidTopNMetricSpec": { "description": "A Druid TopN metric spec.", "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidNumericTopNMetricSpec" }, { "$ref": "#/components/schemas/telemetry.DruidDimensionTopNMetricSpec" }, { "$ref": "#/components/schemas/telemetry.DruidInvertedTopNMetricSpec" } ], "discriminator": { "propertyName": "type", "mapping": { "numeric": "#/components/schemas/telemetry.DruidNumericTopNMetricSpec", "dimension": "#/components/schemas/telemetry.DruidDimensionTopNMetricSpec", "inverted": "#/components/schemas/telemetry.DruidInvertedTopNMetricSpec" } } }, "telemetry.DruidNumericTopNMetricSpec": { "description": "The simplest metric specification is a String value indicating the metric to sort topN results by.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseTopNMetricSpec" }, { "type": "object", "required": [ "metric" ], "properties": { "metric": { "description": "The name of the metric to sort topN results.", "type": "string" } } } ] }, "telemetry.DruidDimensionTopNMetricSpec": { "description": "This metric specification sorts TopN results by dimension value, using one of the sorting orders.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseTopNMetricSpec" }, { "type": "object", "properties": { "ordering": { "description": "Specifies the sorting order. It can be one of the following values. \"lexicographic\", \"alphanumeric\", \"numeric\", \"strlen\". * lexicographic - Sorts values by converting Strings to their UTF-8 byte array representations and comparing lexicographically, byte-by-byte. * alphanumeric - Suitable for strings with both numeric and non-numeric content, e.g., \"file12 sorts after file2\". See https://github.com/amjjd/java-alphanum for more details on how this ordering sorts values. This ordering is not suitable for numbers with decimal points or negative numbers. * numeric - Sorts values as numbers, supports integers and floating point values. Negative values are supported. This sorting order will try to parse all string values as numbers. Unparseable values are treated as nulls, and nulls precede numbers. When comparing two unparseable values (e.g., \"hello\" and \"world\"), this ordering will sort by comparing the unparsed strings lexicographically. * strlen - Sorts values by the their string lengths. When there is a tie, this comparator falls back to using the String compareTo method. * version - Sorts values as versions, e.g., \"10.0 sorts after 9.0\", \"1.0.0-SNAPSHOT sorts after 1.0.0\".", "type": "string", "enum": [ "lexicographic", "alphanumeric", "numeric", "strlen", "version" ], "default": "lexicographic" }, "previousStop": { "description": "The starting point of the sort. For example, if a previousStop value is 'b', all values before 'b' are discarded. This field can be used to paginate through all the dimension values.", "type": "string" } } } ] }, "telemetry.DruidInvertedTopNMetricSpec": { "description": "Sort dimension values in inverted order, i.e inverts the order of the delegate metric spec. It can be used to sort the values in ascending order.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseTopNMetricSpec" }, { "type": "object", "required": [ "metric" ], "properties": { "metric": { "$ref": "#/components/schemas/telemetry.DruidTopNMetricSpec" } } } ] }, "telemetry.DruidBaseDimensionSpec": { "description": "A dimension spec is used in a query to operate on dimension values.", "type": "object", "required": [ "type" ], "properties": { "type": { "description": "the dimension spec type.", "type": "string", "enum": [ "default", "extraction", "listFiltered", "regexFiltered", "prefixFiltered", "lookup" ] } } }, "telemetry.DruidDimensionSpec": { "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidDefaultDimensionSpec" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionDimensionSpec" } ], "discriminator": { "propertyName": "type", "mapping": { "default": "#/components/schemas/telemetry.DruidDefaultDimensionSpec", "extraction": "#/components/schemas/telemetry.DruidExtractionDimensionSpec" } } }, "telemetry.DruidDefaultDimensionSpec": { "description": "Returns dimension values as is and optionally renames the dimension.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseDimensionSpec" }, { "type": "object", "required": [ "dimension", "outputName", "outputType" ], "properties": { "dimension": { "description": "Attributes or fields that provide context for metrics.", "type": "string" }, "outputName": { "description": "Name of the output dimension.", "type": "string" }, "outputType": { "description": "Type of the output dimension.", "type": "string", "enum": [ "STRING", "LONG", "FLOAT" ], "default": "STRING" } } } ] }, "telemetry.DruidExtractionDimensionSpec": { "description": "Returns dimension values transformed using the given extraction function.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseDimensionSpec" }, { "type": "object", "required": [ "dimension", "outputName", "outputType", "extractionFn" ], "properties": { "dimension": { "description": "Attributes or fields that provide context for metrics.", "type": "string" }, "outputName": { "description": "Name of the output dimension.", "type": "string" }, "outputType": { "description": "Type of the output dimension.", "type": "string", "enum": [ "STRING", "LONG", "FLOAT" ], "default": "STRING" }, "extractionFn": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } ] }, "telemetry.DruidExtractionFunction": { "description": "The extraction function is used to transform input values before the filter is applied.\nTransformations can be applied to both regular (string) dimensions, as well as the special __time dimension,\nwhich represents the current time bucket according to the query aggregation granularity.\nFor functions taking string values (such as regular expressions), __time dimension values will be formatted\nin ISO-8601 format before getting passed to the extraction function.\nThe example below shows a selector filter combined with an extraction function. This filter will transform\ninput values according to the values defined in the lookup map; transformed values will then be matched\nwith the string \"bar_1\".", "example": { "type": "lookup", "lookup": { "type": "map", "map": { "product_1": "bar_1", "product_5": "bar_1", "product_3": "bar_1" } } }, "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionRegex" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionPartial" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionSearchQuery" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionSubstring" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionStrlen" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionTimeFormat" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionTimeParsing" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionInlineLookup" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionCascade" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionStringFormat" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionUpperCase" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionLowerCase" }, { "$ref": "#/components/schemas/telemetry.DruidExtractionFunctionBucket" } ], "discriminator": { "propertyName": "type", "mapping": { "regex": "#/components/schemas/telemetry.DruidExtractionFunctionRegex", "partial": "#/components/schemas/telemetry.DruidExtractionFunctionPartial", "searchQuery": "#/components/schemas/telemetry.DruidExtractionFunctionSearchQuery", "substring": "#/components/schemas/telemetry.DruidExtractionFunctionSubstring", "strlen": "#/components/schemas/telemetry.DruidExtractionFunctionStrlen", "timeFormat": "#/components/schemas/telemetry.DruidExtractionFunctionTimeFormat", "time": "#/components/schemas/telemetry.DruidExtractionFunctionTimeParsing", "lookup": "#/components/schemas/telemetry.DruidExtractionFunctionInlineLookup", "cascade": "#/components/schemas/telemetry.DruidExtractionFunctionCascade", "stringFormat": "#/components/schemas/telemetry.DruidExtractionFunctionStringFormat", "upper": "#/components/schemas/telemetry.DruidExtractionFunctionUpperCase", "lower": "#/components/schemas/telemetry.DruidExtractionFunctionLowerCase", "bucket": "#/components/schemas/telemetry.DruidExtractionFunctionBucket" } } }, "telemetry.DruidBaseExtractionFunction": { "type": "object", "description": "Extraction functions define the transformation applied to each dimension value.\nTransformations can be applied to both regular (string) dimensions, as well as the special __time dimension,\nwhich represents the current time bucket according to the query aggregation granularity.", "required": [ "type" ], "properties": { "type": { "description": "The type of extraction function.", "type": "string", "enum": [ "regex", "partial", "searchQuery", "substring", "strlen", "timeFormat", "time", "lookup", "cascade", "stringFormat", "upper", "lower", "bucket" ] } } }, "telemetry.DruidExtractionFunctionRegex": { "description": "Returns the first matching group for the given regular expression. If there is no match, it returns the dimension value as is.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type", "expr" ], "properties": { "type": { "type": "string", "enum": [ "regex" ] }, "expr": { "type": "string" }, "index": { "description": "group to extract, default 1. If \"index\" is set, it will control which group from the match to extract. Index zero extracts the string matching the entire pattern." }, "replaceMissingValue": { "description": "If the replaceMissingValue property is true, the extraction function will transform dimension values that do not match the regex pattern to a user-specified String. Default value is false.", "type": "boolean" }, "replaceMissingValueWith": { "description": "The replaceMissingValueWith property sets the String that unmatched dimension values will be replaced with, if replaceMissingValue is true. If replaceMissingValueWith is not specified, unmatched dimension values will be replaced with nulls.", "type": "string" } } } ] }, "telemetry.DruidExtractionFunctionPartial": { "description": "Returns the dimension value unchanged if the regular expression matches, otherwise returns null.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type", "expr" ], "properties": { "type": { "type": "string", "enum": [ "partial" ] }, "expr": { "type": "string" } } } ] }, "telemetry.DruidExtractionFunctionSearchQuery": { "description": "Returns the dimension value unchanged if the given SearchQuerySpec matches, otherwise returns null.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type", "query" ], "properties": { "type": { "type": "string", "enum": [ "searchQuery" ] }, "query": { "type": "string" } } } ] }, "telemetry.DruidExtractionFunctionSubstring": { "description": "Returns a substring of the dimension value starting from the supplied index and of the desired length.\nBoth index and length are measured in the number of Unicode code units present in the string as if it were encoded in UTF-16.\nNote that some Unicode characters may be represented by two code units.\nIf the desired length exceeds the length of the dimension value, the remainder of the string starting at index will be returned.\nIf index is greater than the length of the dimension value, null will be returned.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type", "index" ], "properties": { "type": { "type": "string", "enum": [ "substring" ] }, "index": { "type": "integer", "format": "int32" }, "length": { "description": "The length may be omitted for substring to return the remainder of the dimension value starting from index, or null if index greater than the length of the dimension value.", "type": "integer", "format": "int32" } } } ] }, "telemetry.DruidExtractionFunctionStrlen": { "description": "Returns the length of dimension values, as measured in the number of Unicode code units present in the string as if it were encoded in UTF-16.\nNote that some Unicode characters may be represented by two code units.\nnull strings are considered as having zero length.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "strlen" ] } } } ] }, "telemetry.DruidExtractionFunctionTimeFormat": { "description": "Returns the dimension value formatted according to the given format string, time zone, and locale.\nFor __time dimension values, this formats the time value bucketed by the aggregation granularity\nFor a regular dimension, it assumes the string is formatted in ISO-8601 date and time format.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "timeFormat" ] }, "format": { "description": "Date time format for the resulting dimension value, in Joda Time DateTimeFormat, or null to use the default ISO8601 format.", "type": "string" }, "locale": { "description": "Locale (language and country) to use, given as a IETF BCP 47 language tag, e.g. en-US, en-GB, fr-FR, fr-CA, etc.", "type": "string" }, "timeZone": { "description": "Time zone to use in IANA tz database format, e.g. Europe/Berlin (this can possibly be different than the aggregation time-zone)", "type": "string" }, "granularity": { "$ref": "#/components/schemas/telemetry.DruidGranularity" }, "asMillis": { "description": "boolean value, set to true to treat input strings as millis rather than ISO8601 strings. Additionally, if format is null or not specified, output will be in millis rather than ISO8601.", "type": "boolean" } } } ] }, "telemetry.DruidExtractionFunctionTimeParsing": { "description": "Parses dimension values as timestamps using the given input format, and returns them formatted using the given output format.\nNote, if you are working with the __time dimension, you should consider using the time extraction function instead instead,\nwhich works on time value directly as opposed to string values.\nIf \"joda\" is true, time formats are described in the Joda DateTimeFormat documentation.\nIf \"joda\" is false (or unspecified) then formats are described in the SimpleDateFormat documentation.\nIn general, we recommend setting \"joda\" to true since Joda format strings are more common in Druid APIs\nand since Joda handles certain edge cases (like weeks and weekyears near the start and end of calendar years) in a more ISO8601 compliant way.\nIf a value cannot be parsed using the provided timeFormat, it will be returned as-is.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "time" ] }, "timeFormat": { "type": "string" }, "resultFormat": { "type": "string" }, "joda": { "type": "boolean" } } } ] }, "telemetry.DruidExtractionFunctionInlineLookup": { "description": "Lookups are a concept in Druid where dimension values are (optionally) replaced with new values.\nThe \"lookup\" extraction function lets you specify an inline lookup.\nA null dimension value can be mapped to a specific value by specifying the empty string as the key in the lookup data.\nThis allows distinguishing between a null dimension and a lookup resulting in a null.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "lookup" ] }, "lookup": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "map" ] }, "map": { "type": "object" } } }, "retainMissingValue": { "description": "Provides a hint how to handle missing values. Setting retainMissingValue to true will use the dimension's original value if it is not found in the lookup. The default values are replaceMissingValueWith = null and retainMissingValue = false which causes missing values to be treated as missing. It is illegal to set retainMissingValue = true and also specify a replaceMissingValueWith.", "type": "boolean" }, "replaceMissingValueWith": { "description": "Provides a hint how to handle missing values. Setting replaceMissingValueWith to \"\" has the same effect as setting it to null or omitting the property.", "type": "string" }, "injective": { "description": "Override the lookup's own sense of whether or not it is injective.", "type": "boolean" }, "optimize": { "description": "Allow optimization of lookup based extraction filter (by default optimize = true). The optimization layer will run on the Broker and it will rewrite the extraction filter as clause of selector filters.", "type": "boolean" } } } ] }, "telemetry.DruidExtractionFunctionCascade": { "description": "Provides chained execution of extraction functions.\nA property of extractionFns contains an array of any extraction functions, which is executed in the array index order.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "cascade" ] }, "extractionFns": { "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } } ] }, "telemetry.DruidExtractionFunctionStringFormat": { "description": "Returns the dimension value formatted according to the given format string.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type", "format" ], "properties": { "type": { "type": "string", "enum": [ "stringFormat" ] }, "format": { "description": "A sprintf expression. For example if you want to concat \"[\" and \"]\" before and after the actual dimension value, you need to specify \"[%s]\" as format string.", "type": "string" }, "nullHandling": { "type": "string", "enum": [ "nullString", "emptyString", "returnNull" ] } } } ] }, "telemetry.DruidExtractionFunctionUpperCase": { "description": "Returns the dimension values as all upper case. Optionally user can specify the language to use in order to perform upper transformation.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "upper" ] }, "locale": { "type": "string" } } } ] }, "telemetry.DruidExtractionFunctionLowerCase": { "description": "Returns the dimension values as all lower case. Optionally user can specify the language to use in order to perform lower transformation.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "lower" ] }, "locale": { "type": "string" } } } ] }, "telemetry.DruidExtractionFunctionBucket": { "description": "Bucket extraction function is used to bucket numerical values in each range of the given size by converting them to the same base value. Non numeric values are converted to null.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseExtractionFunction" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "bucket" ] }, "size": { "description": "The size of the buckets (optional, default 1).", "type": "integer", "format": "int32" }, "offset": { "description": "The offset for the buckets (optional, default 0).", "type": "integer", "format": "int32" } } } ] }, "telemetry.DruidBaseHavingFilter": { "type": "object", "description": "A having clause is a JSON object identifying which rows from a groupBy query should be returned,\nby specifying conditions on aggregated values.\nIt is essentially the equivalent of the HAVING clause in SQL.", "required": [ "type" ], "properties": { "type": { "description": "The having filter type.", "type": "string", "enum": [ "filter", "greaterThan", "equalTo", "lessThan", "dimSelector" ] } } }, "telemetry.DruidHavingFilter": { "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidHavingQueryFilter" }, { "$ref": "#/components/schemas/telemetry.DruidHavingNumericFilter" }, { "$ref": "#/components/schemas/telemetry.DruidHavingDimensionSelectorFilter" } ], "discriminator": { "propertyName": "type", "mapping": { "having": "#/components/schemas/telemetry.DruidHavingQueryFilter", "greaterThan": "#/components/schemas/telemetry.DruidHavingNumericFilter", "equalTo": "#/components/schemas/telemetry.DruidHavingNumericFilter", "lessThan": "#/components/schemas/telemetry.DruidHavingNumericFilter", "dimSelector": "#/components/schemas/telemetry.DruidHavingDimensionSelectorFilter" } } }, "telemetry.DruidHavingQueryFilter": { "description": "Query filter HavingSpecs allow all Druid query filters to be used in the Having part of the query.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseHavingFilter" }, { "type": "object", "required": [ "filter" ], "properties": { "filter": { "$ref": "#/components/schemas/telemetry.DruidFilter" } } } ] }, "telemetry.DruidHavingNumericFilter": { "description": "The simplest having clause is a numeric filter. Numeric filters can be used as the base filters\nfor more complex boolean expressions of filters.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseHavingFilter" }, { "type": "object", "required": [ "aggregation", "value" ], "properties": { "aggregation": { "description": "aggregate metric", "type": "string" }, "value": { "description": "Value for the filter to match.", "type": "number", "format": "double" } } } ] }, "telemetry.DruidHavingDimensionSelectorFilter": { "description": "The dimSelector filter will match rows with dimension values equal to the specified value.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseHavingFilter" }, { "type": "object", "required": [ "dimension", "value" ], "properties": { "dimension": { "description": "dimension", "type": "string" }, "value": { "description": "Value for the filter to match.", "type": "number", "format": "double" } } } ] }, "telemetry.DruidBaseFilter": { "type": "object", "description": "A filter is a JSON object indicating which rows of data should be included in the computation for a query.\nIt's essentially the equivalent of the WHERE clause in SQL.", "required": [ "type" ], "properties": { "type": { "type": "string", "description": "The filter type.", "enum": [ "selector", "equality", null, "columnComparison", "and", "or", "not", "in", "bound", "range", "like", "regex", "interval", true, false, "search", "expression" ] } } }, "telemetry.DruidFilter": { "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidSelectorFilter" }, { "$ref": "#/components/schemas/telemetry.DruidEqualityFilter" }, { "$ref": "#/components/schemas/telemetry.DruidNullFilter" }, { "$ref": "#/components/schemas/telemetry.DruidColumnComparisonFilter" }, { "$ref": "#/components/schemas/telemetry.DruidAndFilter" }, { "$ref": "#/components/schemas/telemetry.DruidOrFilter" }, { "$ref": "#/components/schemas/telemetry.DruidNotFilter" }, { "$ref": "#/components/schemas/telemetry.DruidInFilter" }, { "$ref": "#/components/schemas/telemetry.DruidBoundFilter" }, { "$ref": "#/components/schemas/telemetry.DruidRangeFilter" }, { "$ref": "#/components/schemas/telemetry.DruidLikeFilter" }, { "$ref": "#/components/schemas/telemetry.DruidRegexFilter" }, { "$ref": "#/components/schemas/telemetry.DruidIntervalFilter" }, { "$ref": "#/components/schemas/telemetry.DruidTrueFilter" }, { "$ref": "#/components/schemas/telemetry.DruidFalseFilter" }, { "$ref": "#/components/schemas/telemetry.DruidSearchFilter" }, { "$ref": "#/components/schemas/telemetry.DruidExpressionFilter" } ], "discriminator": { "propertyName": "type", "mapping": { "selector": "#/components/schemas/telemetry.DruidSelectorFilter", "equality": "#/components/schemas/telemetry.DruidEqualityFilter", "null": "#/components/schemas/telemetry.DruidNullFilter", "columnComparison": "#/components/schemas/telemetry.DruidColumnComparisonFilter", "and": "#/components/schemas/telemetry.DruidAndFilter", "or": "#/components/schemas/telemetry.DruidOrFilter", "not": "#/components/schemas/telemetry.DruidNotFilter", "in": "#/components/schemas/telemetry.DruidInFilter", "bound": "#/components/schemas/telemetry.DruidBoundFilter", "range": "#/components/schemas/telemetry.DruidRangeFilter", "like": "#/components/schemas/telemetry.DruidLikeFilter", "regex": "#/components/schemas/telemetry.DruidRegexFilter", "interval": "#/components/schemas/telemetry.DruidIntervalFilter", "true": "#/components/schemas/telemetry.DruidTrueFilter", "false": "#/components/schemas/telemetry.DruidFalseFilter", "search": "#/components/schemas/telemetry.DruidSearchFilter", "expression": "#/components/schemas/telemetry.DruidExpressionFilter" } } }, "telemetry.DruidSelectorFilter": { "description": "The selector filter matches a specific dimension with a specific value.\nSelector filters can be used as the base filters for more complex Boolean expressions of filters.\nThe selector filter supports the use of extraction functions.\nSee [Filtering with Extraction Functions](https://druid.apache.org/docs/latest/querying/filters.html#filtering-with-extraction-functions) for details.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "dimension", "value" ], "properties": { "type": { "type": "string", "enum": [ "selector" ] }, "dimension": { "description": "The name of a dimension.", "type": "string" }, "value": { "description": "The value of a dimension.", "type": "string" }, "extractionFn": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } ] }, "telemetry.DruidEqualityFilter": { "description": "The equality filter is a replacement for the selector filter with the ability to match against any type of column.\nThe equality filter is designed to have more SQL compatible behavior than the selector filter and so can not match null values.\nTo match null values use the null filter.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "column", "matchValueType", "matchValue" ], "properties": { "type": { "type": "string", "enum": [ "equality" ] }, "column": { "description": "Input column or virtual column name to filter.", "type": "string" }, "matchValueType": { "description": "String specifying the type of value to match. For example STRING, LONG, DOUBLE, FLOAT, ARRAY, ARRAY, or any other Druid type. The matchValueType determines how Druid interprets the matchValue to assist in converting to the type of the matched column.", "type": "string" }, "matchValue": { "description": "Value to match, must not be null." } } } ] }, "telemetry.DruidNullFilter": { "description": "The null filter is a partial replacement for the selector filter. It is dedicated to matching NULL values.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "column" ], "properties": { "type": { "type": "string", "enum": [ "null" ] }, "column": { "description": "Input column or virtual column name to filter.", "type": "string" } } } ] }, "telemetry.DruidInFilter": { "description": "The in filter can match input rows against a set of values, where a match occurs if the value is contained in the set.\nIf an empty values array is passed to the \"in\" filter, it will simply return an empty result.\nIf the values array contains null, the \"in\" filter matches null values.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "dimension", "values" ], "properties": { "type": { "type": "string", "enum": [ "in" ] }, "dimension": { "description": "Input column or virtual column name to filter.", "type": "string" }, "values": { "description": "List of string value to match.", "type": "array", "items": { "type": "string" } }, "extractionFn": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } ] }, "telemetry.DruidBoundFilter": { "description": "Bound filters can be used to filter on ranges of dimension values.\nIt can be used for comparison filtering like greater than, less than, greater than or equal to, less than or equal to,\nand \"between\" (if both \"lower\" and \"upper\" are set).\nWhen the bound filter matches against numeric inputs, the string lower and upper bound values are best-effort\ncoerced into a numeric value when using the \"numeric\" mode of ordering.\nThe bound filter can only match against STRING (single and multi-valued), LONG, FLOAT, DOUBLE types.\nUse the newer range to match against ARRAY or COMPLEX types.\nNote that the bound filter matches null values if you don't specify a lower bound.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "dimension" ], "properties": { "type": { "type": "string", "enum": [ "bound" ] }, "dimension": { "description": "Input column or virtual column name to filter.", "type": "string" }, "lower": { "description": "The lower bound string match value for the filter.", "type": "string" }, "upper": { "description": "The upper bound string match value for the filter.", "type": "string" }, "lowerStrict": { "description": "Boolean indicating whether to perform strict comparison on the lower bound (\">\" instead of \">=\").", "type": "boolean" }, "upperStrict": { "description": "Boolean indicating whether to perform strict comparison on the upper bound (\"<\" instead of \"<=\").", "type": "boolean" }, "ordering": { "description": "String that specifies the sorting order to use when comparing values against the bound. lexicographic - Sorts values by converting Strings to their UTF-8 byte array representations and comparing lexicographically, byte-by-byte.\nalphanumeric - Suitable for strings with both numeric and non-numeric content, e.g., \"file12 sorts after file2\" This ordering is not suitable for numbers with decimal points or negative numbers. For example, \"1.3\" precedes \"1.15\" in this ordering because \"15\" has more significant digits than \"3\". Negative numbers are sorted after positive numbers (because numeric characters precede the \"-\" in the negative numbers).\nnumeric - Sorts values as numbers, supports integers and floating point values. Negative values are supported. This sorting order will try to parse all string values as numbers. Unparseable values are treated as nulls, and nulls precede numbers. When comparing two unparseable values (e.g., \"hello\" and \"world\"), this ordering will sort by comparing the unparsed strings lexicographically.\nstrlen - Sorts values by their string lengths. When there is a tie, this comparator falls back to using the String compareTo method.\nversion - Sorts values as versions, e.g., \"10.0 sorts after 9.0\", \"1.0.0-SNAPSHOT sorts after 1.0.0\".", "type": "string", "enum": [ "lexicographic", "alphanumeric", "numeric", "strlen", "version" ] }, "extractionFn": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } ] }, "telemetry.DruidRangeFilter": { "description": "The range filter is a replacement for the bound filter.\nIt compares against any type of column and is designed to have has more SQL compliant behavior than the bound filter.\nIt won't match null values, even if you don't specify a lower bound.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "column", "matchValueType" ], "properties": { "type": { "type": "string", "enum": [ "range" ] }, "column": { "description": "Input column or virtual column name to filter.", "type": "string" }, "matchValueType": { "description": "String specifying the type of bounds to match. For example STRING, LONG, DOUBLE, FLOAT, ARRAY, ARRAY, or any other Druid type. The matchValueType determines how Druid interprets the matchValue to assist in converting to the type of the matched column and also defines the type of comparison used when matching values.", "type": "string" }, "lower": { "description": "Lower bound value to match. At least one of lower or upper must not be null." }, "upper": { "description": "Upper bound value to match. At least one of lower or upper must not be null." }, "lowerOpen": { "description": "Boolean indicating if lower bound is open in the interval of values defined by the range (\">\" instead of \">=\").", "type": "boolean" }, "upperOpen": { "description": "Boolean indicating if upper bound is open on the interval of values defined by the range (\"<\" instead of \"<=\").", "type": "boolean" } } } ] }, "telemetry.DruidLikeFilter": { "description": "Like filters can be used for basic wildcard searches.\nThey are equivalent to the SQL LIKE operator.\nSpecial characters supported are \"%\" (matches any number of characters) and \"_\" (matches any one character).", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "dimension", "pattern" ], "properties": { "type": { "type": "string", "enum": [ "like" ] }, "dimension": { "description": "Input column or virtual column name to filter.", "type": "string" }, "pattern": { "description": "String LIKE pattern, such as \"foo%\" or \"___bar\".", "type": "string" }, "escape": { "description": "A string escape character that can be used to escape special characters.", "type": "string" }, "extractionFn": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } ] }, "telemetry.DruidColumnComparisonFilter": { "description": "The column comparison filter compares dimensions to each other.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "dimensions", "type" ], "properties": { "type": { "type": "string", "enum": [ "columnComparison" ] }, "dimensions": { "description": "A list of DimensionSpecs, making it possible to apply an extraction function if needed.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidDimensionSpec" } } } } ] }, "telemetry.DruidRegexFilter": { "description": "The regular expression filter is similar to the selector filter, but using regular expressions.\nIt matches the specified dimension with the given pattern.\nNote that it is often more optimal to use a like filter instead of a regex for simple matching of prefixes.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "dimension", "pattern" ], "properties": { "type": { "type": "string", "enum": [ "regex" ] }, "dimension": { "description": "Input column or virtual column name to filter.", "type": "string" }, "pattern": { "description": "String pattern to match - any standard Java regular expression.", "type": "string" }, "extractionFn": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } ] }, "telemetry.DruidIntervalFilter": { "description": "The Interval filter enables range filtering on columns that contain long millisecond values,\nwith the boundaries specified as ISO 8601 time intervals.\nIt is suitable for the __time column, long metric columns, and dimensions with values that can be parsed as long milliseconds.\nThis filter converts the ISO 8601 intervals to long millisecond start/end ranges and translates to an OR of Bound filters\non those millisecond ranges, with numeric comparison.\nThe Bound filters will have left-closed and right-open matching (i.e., start <= time < end).\nThe interval filter supports the use of extraction functions.\nIf an extraction function is used with this filter, the extraction function should output values that are parseable\nas long milliseconds.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "dimension", "intervals" ], "properties": { "type": { "type": "string", "enum": [ "interval" ] }, "dimension": { "description": "Input column or virtual column name to filter.", "type": "string" }, "intervals": { "description": "A JSON array containing ISO-8601 interval strings that defines the time ranges to filter on.", "type": "array", "items": { "type": "string" } }, "extractionFn": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } ] }, "telemetry.DruidTrueFilter": { "description": "A filter which matches all values. You can use it to temporarily disable other filters without removing them.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "true" ] } } } ] }, "telemetry.DruidFalseFilter": { "description": "A filter matches no values. You can use it to force a query to match no values.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "false" ] } } } ] }, "telemetry.DruidSearchFilter": { "description": "You can use search filters to filter on partial string matches.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "dimension", "query" ], "properties": { "type": { "type": "string", "enum": [ "search" ] }, "dimension": { "description": "Input column or virtual column name to filter.", "type": "string" }, "query": { "$ref": "#/components/schemas/telemetry.DruidQuerySpec" }, "extractionFn": { "$ref": "#/components/schemas/telemetry.DruidExtractionFunction" } } } ] }, "telemetry.DruidBaseQuerySpec": { "type": "object", "description": "A Druid query spec.", "required": [ "type" ], "properties": { "type": { "description": "The type of query spec.", "type": "string", "enum": [ "contains", "insensitive_contains", "fragment" ] } } }, "telemetry.DruidQuerySpec": { "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidQuerySpecContains" }, { "$ref": "#/components/schemas/telemetry.DruidQuerySpecInsensitiveContains" }, { "$ref": "#/components/schemas/telemetry.DruidQuerySpecFragment" } ], "discriminator": { "propertyName": "type", "mapping": { "contains": "#/components/schemas/telemetry.DruidQuerySpecContains", "insensitive_contains": "#/components/schemas/telemetry.DruidQuerySpecInsensitiveContains", "fragment": "#/components/schemas/telemetry.DruidQuerySpecFragment" } } }, "telemetry.DruidQuerySpecContains": { "description": "A 'contains' query spec.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseQuerySpec" }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "contains" ] }, "value": { "description": "A String value to search.", "type": "string" }, "caseSensitive": { "description": "Whether the string comparison is case-sensitive or not.", "type": "boolean" } } } ] }, "telemetry.DruidQuerySpecInsensitiveContains": { "description": "A 'insensitive_contains' query spec. Note that an \"insensitive_contains\" search is equivalent to a \"contains\" search with \"caseSensitive\" false (or not provided).", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseQuerySpec" }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "insensitive_contains" ] }, "value": { "description": "A String value to search.", "type": "string" } } } ] }, "telemetry.DruidQuerySpecFragment": { "description": "A 'fragment' query spec.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseQuerySpec" }, { "type": "object", "required": [ "type", "values" ], "properties": { "type": { "type": "string", "enum": [ "fragment" ] }, "values": { "description": "A JSON array of string values to search.", "type": "array", "items": { "type": "string" } }, "caseSensitive": { "description": "Whether the string comparison is case-sensitive or not.", "type": "boolean" } } } ] }, "telemetry.DruidExpressionFilter": { "description": "The expression filter allows for the implementation of arbitrary conditions,\nleveraging the Druid expression system. This filter allows for complete flexibility,\nbut it might be less performant than a combination of the other filters on this page because\nit can't always use the same optimizations available to other filters.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "type", "expression" ], "properties": { "type": { "type": "string", "enum": [ "expression" ] }, "expression": { "description": "Expression string to evaluate into true or false. See the Druid expression system for more details.", "type": "string" } } } ] }, "telemetry.DruidAndFilter": { "description": "A logical AND expression filter.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "fields", "type" ], "properties": { "type": { "type": "string", "enum": [ "and" ] }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidFilter" } } } } ] }, "telemetry.DruidOrFilter": { "description": "A logical OR expression filter.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "fields", "type" ], "properties": { "type": { "type": "string", "enum": [ "or" ] }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidFilter" } } } } ] }, "telemetry.DruidNotFilter": { "description": "A logical NOT expression filter.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseFilter" }, { "type": "object", "required": [ "field", "type" ], "properties": { "type": { "type": "string", "enum": [ "not" ] }, "field": { "$ref": "#/components/schemas/telemetry.DruidFilter" } } } ] }, "telemetry.DruidBaseAggregator": { "type": "object", "description": "A Druid aggregator.", "required": [ "type" ], "properties": { "type": { "description": "The aggregator type.", "type": "string", "enum": [ "count", "longSum", "doubleSum", "floatSum", "doubleMin", "doubleMax", "floatMin", "floatMax", "longMin", "longMax", "doubleFirst", "doubleLast", "floatFirst", "floatLast", "longFirst", "longLast", "stringFirst", "stringLast", "doubleAny", "floatAny", "longAny", "stringAny", "thetaSketch", "filtered" ] } } }, "telemetry.DruidAggregator": { "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidCountAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidSumAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidMinMaxAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidFirstLastAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidStringFirstLastAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidAnyAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidStringAnyAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidThetaSketchAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidFilteredAggregator" } ], "discriminator": { "propertyName": "type", "mapping": { "count": "#/components/schemas/telemetry.DruidCountAggregator", "doubleSum": "#/components/schemas/telemetry.DruidSumAggregator", "floatSum": "#/components/schemas/telemetry.DruidSumAggregator", "longSum": "#/components/schemas/telemetry.DruidSumAggregator", "doubleMin": "#/components/schemas/telemetry.DruidMinMaxAggregator", "doubleMax": "#/components/schemas/telemetry.DruidMinMaxAggregator", "floatMin": "#/components/schemas/telemetry.DruidMinMaxAggregator", "floatMax": "#/components/schemas/telemetry.DruidMinMaxAggregator", "longMin": "#/components/schemas/telemetry.DruidMinMaxAggregator", "longMax": "#/components/schemas/telemetry.DruidMinMaxAggregator", "doubleFirst": "#/components/schemas/telemetry.DruidFirstLastAggregator", "doubleLast": "#/components/schemas/telemetry.DruidFirstLastAggregator", "floatFirst": "#/components/schemas/telemetry.DruidFirstLastAggregator", "floatLast": "#/components/schemas/telemetry.DruidFirstLastAggregator", "longFirst": "#/components/schemas/telemetry.DruidFirstLastAggregator", "longLast": "#/components/schemas/telemetry.DruidFirstLastAggregator", "stringFirst": "#/components/schemas/telemetry.DruidStringFirstLastAggregator", "stringLast": "#/components/schemas/telemetry.DruidStringFirstLastAggregator", "doubleAny": "#/components/schemas/telemetry.DruidAnyAggregator", "floatAny": "#/components/schemas/telemetry.DruidAnyAggregator", "longAny": "#/components/schemas/telemetry.DruidAnyAggregator", "stringAny": "#/components/schemas/telemetry.DruidStringAnyAggregator", "thetaSketch": "#/components/schemas/telemetry.DruidThetaSketchAggregator", "filtered": "#/components/schemas/telemetry.DruidFilteredAggregator" } } }, "telemetry.DruidCountAggregator": { "description": "Computes the count of Druid rows that match the filters. The count aggregator counts the number of Druid rows, which does not always reflect the number of raw events ingested. This is because Druid can be configured to roll up data at ingestion time To count the number of ingested rows of data, include a count aggregator at ingestion time, and a longSum aggregator at query time.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "properties": { "name": { "description": "the output name", "type": "string" } } } ] }, "telemetry.DruidSumAggregator": { "description": "Computes the sum of values.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "required": [ "name", "fieldName" ], "properties": { "name": { "description": "Output name for the summed value.", "type": "string" }, "fieldName": { "description": "Name of the metric column to sum over.", "type": "string" } } } ] }, "telemetry.DruidMinMaxAggregator": { "description": "Computes the min or max of values.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "required": [ "name", "fieldName" ], "properties": { "name": { "description": "Output name for the min/max value.", "type": "string" }, "fieldName": { "description": "Name of the metric column.", "type": "string" } } } ] }, "telemetry.DruidFirstLastAggregator": { "description": "(Double/Float/Long) First and Last aggregator cannot be used in ingestion spec, and should\nonly be specified as part of queries.\nNote that queries with first/last aggregators on a segment created with rollup enabled will\nreturn the rolled up value, and not the last value within the raw ingested data.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "required": [ "name", "fieldName" ], "properties": { "name": { "description": "Output name for the first/last value.", "type": "string" }, "fieldName": { "description": "Name of the metric column.", "type": "string" } } } ] }, "telemetry.DruidStringFirstLastAggregator": { "description": "Computes the metric value with the minimum/maximum timestamp or null if no row exist.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "required": [ "name", "fieldName" ], "properties": { "name": { "description": "Output name for the first or last value.", "type": "string" }, "fieldName": { "description": "Name of the metric column.", "type": "string" }, "maxStringBytes": { "description": "Size in bytes limit on aggregation size.", "type": "integer", "default": 1024 } } } ] }, "telemetry.DruidAnyAggregator": { "description": "Returns any value including null. This aggregator can simplify and optimize\nthe performance by returning the first encountered value (including null).", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "required": [ "name", "fieldName" ], "properties": { "name": { "description": "Output name for the 'any' value.", "type": "string" }, "fieldName": { "description": "Name of the metric column.", "type": "string" } } } ] }, "telemetry.DruidStringAnyAggregator": { "description": "Returns any value including null. This aggregator can simplify and optimize\nthe performance by returning the first encountered value (including null).", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "required": [ "name", "fieldName" ], "properties": { "name": { "description": "Output name for the 'any' value.", "type": "string" }, "fieldName": { "description": "Name of the metric column.", "type": "string" }, "maxStringBytes": { "description": "Size in bytes limit on aggregation size.", "type": "integer", "default": 1024 } } } ] }, "telemetry.DruidFilteredAggregator": { "description": "A filtered aggregator wraps any given aggregator, but only aggregates the values for\nwhich the given dimension filter matches.\nThis makes it possible to compute the results of a filtered and an unfiltered aggregation\nsimultaneously, without having to issue multiple queries, and use both results as part\nof post-aggregations.\nIf only the filtered results are required, consider putting the filter on the query\nitself, which will be much faster since it does not require scanning all the data.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "required": [ "filter", "aggregator" ], "properties": { "filter": { "$ref": "#/components/schemas/telemetry.DruidFilter" }, "aggregator": { "$ref": "#/components/schemas/telemetry.DruidAggregator" } } } ] }, "telemetry.DruidThetaSketchAggregator": { "description": "Theta sketch aggregation provides a class of specialized algorithms, called streaming algorithms,\nor sketches that can produce results orders-of magnitude faster and with mathematically proven\nerror bounds. For interactive queries there may not be other viable alternatives, and in the\ncase of real-time analysis, sketches are the only known solution.\nIn the analysis of big data there are often problem queries that don't scale because\nthey require huge compute resources and time to generate exact results. Examples include\ncount distinct, quantiles, most-frequent items, joins, matrix computations, and graph analysis.\nIf approximate results are acceptable, theta sketch aggregation can be used.\nLogically speaking, a Theta sketch object can be thought of as a set data structure.\nSketches are read and aggregated (set unioned) together. A theta sketch query returns\nthe estimate of the number of unique entries in the sketch object.\nYou can use post aggregators to do union, intersection or difference on sketch columns\nin the same row.\nYou can use thetaSketch aggregator on columns which were not ingested using the same.\nIt will return estimated cardinality of the column.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseAggregator" }, { "type": "object", "required": [ "name", "fieldName" ], "properties": { "name": { "description": "A String for the output (result) name of the calculation.", "type": "string" }, "fieldName": { "description": "A String for the name of the aggregator used at ingestion time.", "type": "string" }, "size": { "description": "Must be a power of 2. Internally, size refers to the maximum number of entries sketch object will retain. Higher size means higher accuracy but more space to store sketches. Note that after you index with a particular size, druid will persist sketch in segments and you will use size greater or equal to that at query time. In general, We recommend just sticking to default size.", "type": "integer", "default": 16384 } } } ] }, "telemetry.DruidBaseLimitSpec": { "description": "The limitSpec field provides the functionality to sort and limit the set of results from a groupBy query. If you group by a single dimension and are ordering by a single metric, we highly recommend using TopN Queries instead. The performance will be substantially better.", "required": [ "type" ], "properties": { "type": { "description": "The limit spec type.", "type": "string", "enum": [ "default" ] } } }, "telemetry.DruidDefaultLimitSpec": { "description": "The default limit spec takes a limit and the list of columns to do an orderBy operation over.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseLimitSpec" }, { "type": "object", "required": [ "limit", "columns" ], "properties": { "limit": { "description": "How many rows to return. If not specified, all rows will be returned.", "type": "integer" }, "columns": { "description": "Optional list of columns to order by.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidOrderByColumnSpec" } } } } ] }, "telemetry.DruidOrderByColumnSpec": { "description": "OrderByColumnSpecs indicate how to do order by operations. Each order-by condition can be a jsonString or a map.", "type": "object", "properties": { "dimension": { "description": "Any dimension or metric name.", "type": "string" }, "direction": { "description": "Direction of sorting. The default value is ascending.", "type": "string", "enum": [ "ascending", "descending" ] }, "dimensionOrder": { "description": "Collation function for sorting. The default value is lexicographic.", "type": "string", "enum": [ "lexicographic", "alphanumeric", "strlen", "numeric" ] } } }, "telemetry.DruidBaseVirtualColumn": { "type": "object", "description": "Virtual columns are columns that are computed on the fly during query execution.\nIf you include a virtual column as part of a query, make sure to include all attributes\nthe virtual column requires.\nRefer https://druid.apache.org/docs/latest/querying/virtual-columns/ for more details.", "required": [ "type" ], "properties": { "type": { "description": "The virtual-column type.", "type": "string", "enum": [ "expression", "nested-field", "mv-filtered" ] } } }, "telemetry.DruidVirtualColumn": { "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidExpressionVirtualColumn" }, { "$ref": "#/components/schemas/telemetry.NestedFieldVirtualColumn" }, { "$ref": "#/components/schemas/telemetry.DruidListFilteredVirtualColumn" } ], "discriminator": { "propertyName": "type", "mapping": { "expression": "#/components/schemas/telemetry.DruidExpressionVirtualColumn", "nested-field": "#/components/schemas/telemetry.NestedFieldVirtualColumn", "mv-filtered": "#/components/schemas/telemetry.DruidListFilteredVirtualColumn" } } }, "telemetry.DruidExpressionVirtualColumn": { "description": "A virtual column defined as a Druid expression. Supported Druid expressions are documented at\nhttps://druid.apache.org/docs/latest/misc/math-expr.html.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseVirtualColumn" }, { "type": "object", "properties": { "name": { "description": "Name of the virtual column.", "type": "string" }, "expression": { "description": "The Druid expression.", "type": "string" }, "outputType": { "description": "Type of the resulting column.", "type": "string", "enum": [ "LONG", "FLOAT", "DOUBLE", "STRING", "ARRAY", "COMPLEX" ], "default": "FLOAT" } } } ] }, "telemetry.NestedFieldVirtualColumn": { "description": "A virtual column defined as a nested field. The nested field virtual column is an optimized\nvirtual column that can provide direct access into various paths of a json column, including\nusing their indexes. This virtual column is used for the SQL operators JSON_VALUE\n(if processFromRaw is set to false) or JSON_QUERY (if processFromRaw is true), and accepts\n'JSONPath' or 'jq' syntax string representations of paths, or a parsed list of \"path parts\"\nin order to determine what should be selected from the column.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseVirtualColumn" }, { "type": "object", "properties": { "columnName": { "description": "Name of the COMPLEX input column.", "type": "string" }, "outputName": { "description": "Name of the virtual column.", "type": "string" }, "expectedType": { "description": "Native druid output type of the column. Druid will coerce output to this type if it\ndoes not match the underlying type.", "type": "string", "enum": [ "LONG", "FLOAT", "DOUBLE", "STRING", "COMPLEX" ], "default": "STRING" }, "pathParts": { "description": "A list of path parts that represent the path to the desired value in the json column.\nEach path part can be a string or an integer. If a path part is an integer, it is\ntreated as an index into an array.", "type": "array", "items": { "type": "object", "properties": { "type": { "description": "Type of the path part. Use 'field' when accessing a specific field in\na nested structure. Use 'arrayElement' when accessing a specific integer position\nof an array.", "type": "string", "enum": [ "field", "arrayElement" ] }, "field": { "description": "Name of the field in the field type path part.", "type": "string" }, "index": { "description": "Index of the array element.", "type": "integer" } } } }, "processFromRaw": { "description": "If set to true, the virtual column will process the \"raw\" JSON data to extract values\nrather than using an optimized \"literal\" value selector. This option allows extracting\nnon-literal values from JSON the cost of much slower performance.", "type": "boolean", "default": false }, "path": { "description": "A JSONPath or jq syntax string representation of the path to the desired value in the json column.\nThis field is optional and can be used instead of pathParts.", "type": "string" }, "useJqSyntax": { "description": "If set to true, the virtual column will use jq syntax instead of JSONPath.", "type": "boolean", "default": false } } } ] }, "telemetry.DruidListFilteredVirtualColumn": { "description": "This virtual column provides an alternative way to use 'list filtered' dimension spec as a virtual column.\nIt has optimized access to the underlying column value indexes that can provide a small performance\nimprovement in some cases.\nRefer https://druid.apache.org/docs/latest/querying/dimensionspecs/#filtered-dimensionspecs for more details.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseVirtualColumn" }, { "type": "object", "properties": { "name": { "description": "name of the virtual column.", "type": "string" }, "delegate": { "description": "Name of the multi-value string input column to filter.", "type": "string" }, "values": { "description": "Set of string value to allow or deny.", "type": "array", "items": { "type": "string" } }, "isAllowList": { "description": "If set to true, the virtual column will allow only the values in the list.\nIf set to false, the virtual column will provide all values except those specified.", "type": "boolean", "default": true } } } ] }, "telemetry.DruidBasePostAggregator": { "type": "object", "description": "Post-aggregations are specifications of processing that should happen on aggregated values as\nthey come out of Apache Druid. If you include a post aggregation as part of a query, make sure\nto include all aggregators the post-aggregator requires.", "required": [ "type" ], "properties": { "type": { "description": "The post-aggregator type.", "type": "string", "enum": [ "arithmetic", "expression", "fieldAccess", "finalizingFieldAccess", "constant", "doubleGreatest", "longGreatest", "doubleLeast", "longLeast", "hyperUniqueCardinality", "thetaSketchEstimate", "thetaSketchSetOp" ] }, "fields": { "description": "Fields processed by post aggregator", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidPostAggregator" } } } }, "telemetry.DruidPostAggregator": { "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidArithmeticPostAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidExpressionPostAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidFieldAccessorPostAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidConstantPostAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidGreatestLeastPostAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidHyperUniquePostAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidThetaSketchEstimatePostAggregator" }, { "$ref": "#/components/schemas/telemetry.DruidThetaSketchOperationsPostAggregator" } ], "discriminator": { "propertyName": "type", "mapping": { "arithmetic": "#/components/schemas/telemetry.DruidArithmeticPostAggregator", "expression": "#/components/schemas/telemetry.DruidExpressionPostAggregator", "fieldAccess": "#/components/schemas/telemetry.DruidFieldAccessorPostAggregator", "finalizingFieldAccess": "#/components/schemas/telemetry.DruidFieldAccessorPostAggregator", "constant": "#/components/schemas/telemetry.DruidConstantPostAggregator", "doubleGreatest": "#/components/schemas/telemetry.DruidGreatestLeastPostAggregator", "longGreatest": "#/components/schemas/telemetry.DruidGreatestLeastPostAggregator", "doubleLeast": "#/components/schemas/telemetry.DruidGreatestLeastPostAggregator", "longLeast": "#/components/schemas/telemetry.DruidGreatestLeastPostAggregator", "hyperUniqueCardinality": "#/components/schemas/telemetry.DruidHyperUniquePostAggregator", "thetaSketchEstimate": "#/components/schemas/telemetry.DruidThetaSketchEstimatePostAggregator", "thetaSketchSetOp": "#/components/schemas/telemetry.DruidThetaSketchOperationsPostAggregator" } } }, "telemetry.DruidArithmeticPostAggregator": { "description": "The arithmetic post-aggregator applies the provided function to the given fields from left to right.\nThe fields can be aggregators or other post aggregators.\nSupported functions are +, -, *, /, and quotient.\n/ division always returns 0 if dividing by 0, regardless of the numerator.\nquotient division behaves like regular floating point division.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBasePostAggregator" }, { "type": "object", "properties": { "name": { "description": "Output name for the minimum/maximum timestamp value.", "type": "string" }, "fn": { "description": "A post-aggregation arithmetic function.", "type": "string", "enum": [ "+", "-", "*", "/", "quotient" ] }, "ordering": { "description": "Arithmetic post-aggregators may specify an ordering, which defines the order of resulting\nvalues when sorting results. This can be useful for topN queries for instance.\nIf no ordering (or null) is specified, the default floating point ordering is used.\nnumericFirst ordering always returns finite values first, followed by NaN, and infinite values last.", "type": "string" } } } ] }, "telemetry.DruidExpressionPostAggregator": { "description": "A post-aggregator defined as a Druid expression. Supported Druid expressions are documented at\nhttps://druid.apache.org/docs/latest/misc/math-expr.html.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBasePostAggregator" }, { "type": "object", "properties": { "name": { "description": "Output name for the return value of the expression.", "type": "string" }, "expression": { "description": "The Druid expression.", "type": "string" }, "ordering": { "description": "Expression post-aggregators may specify an ordering, which defines the order of resulting\nvalues when sorting results.\nIf no ordering (or null) is specified, the default floating point ordering is used.\nnumericFirst ordering always returns finite values first, followed by NaN, and infinite values last.", "type": "string" } } } ] }, "telemetry.DruidFieldAccessorPostAggregator": { "description": "These post-aggregators return the value produced by the specified aggregator.\n'fieldName' refers to the output name of the aggregator given in the aggregations portion of the query.\nFor complex aggregators, like \"cardinality\" and \"hyperUnique\", the type of the post-aggregator\ndetermines what the post-aggregator will return. Use type \"fieldAccess\" to return the raw aggregation\nobject, or use type \"finalizingFieldAccess\" to return a finalized value, such as an estimated cardinality.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBasePostAggregator" }, { "type": "object", "properties": { "name": { "description": "Output name for the post-aggregator.", "type": "string" }, "fieldName": { "description": "Name of the metric column.", "type": "string" } } } ] }, "telemetry.DruidConstantPostAggregator": { "description": "The constant post-aggregator always returns the specified value.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBasePostAggregator" }, { "type": "object", "properties": { "name": { "description": "Output name for the post-aggregator.", "type": "string" }, "value": { "description": "The numerical value.", "type": "number", "format": "double" } } } ] }, "telemetry.DruidGreatestLeastPostAggregator": { "description": "doubleGreatest and longGreatest computes the maximum of all fields and Double.NEGATIVE_INFINITY.\ndoubleLeast and longLeast computes the minimum of all fields and Double.POSITIVE_INFINITY.\nThe difference between the doubleMax aggregator and the doubleGreatest post-aggregator\nis that doubleMax returns the highest value of all rows for one specific column while\ndoubleGreatest returns the highest value of multiple columns in one row.\nThese are similar to the SQL MAX and GREATEST functions.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBasePostAggregator" }, { "type": "object", "properties": { "name": { "description": "Output name for the post-aggregator.", "type": "string" } } } ] }, "telemetry.DruidHyperUniquePostAggregator": { "description": "The hyperUniqueCardinality post aggregator is used to wrap a hyperUnique object such that\nit can be used in post aggregations.\nThis post-aggregator will inherit the rounding behavior of the aggregator it references.\nNote that this inheritance is only effective if you directly reference an aggregator.\nGoing through another post-aggregator, for example, will cause the user-specified rounding\nbehavior to get lost and default to \"no rounding\".", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBasePostAggregator" }, { "type": "object", "properties": { "name": { "description": "Output name for the post-aggregator.", "type": "string" }, "fieldName": { "description": "The name field value of the hyperUnique aggregator.", "type": "string" } } } ] }, "telemetry.DruidThetaSketchEstimatePostAggregator": { "description": "Post aggregator of type fieldAccess that refers to a thetaSketch aggregator or\nthat of type thetaSketchSetOp.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBasePostAggregator" }, { "type": "object", "properties": { "name": { "description": "Output name for the post-aggregator.", "type": "string" }, "field": { "description": "Post aggregator of type fieldAccess that refers to a thetaSketch aggregator or that of type thetaSketchSetOp.", "type": "string" } } } ] }, "telemetry.DruidThetaSketchOperationsPostAggregator": { "description": "", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBasePostAggregator" }, { "type": "object", "properties": { "name": { "description": "Output name for the post-aggregator.", "type": "string" }, "func": { "type": "string", "enum": [ "UNION", "INTERSECT", "NOT" ] }, "size": { "description": "must be max of size from sketches in fields input.", "type": "integer", "default": 16384 } } } ] }, "telemetry.DruidQueryContext": { "description": "The query context is used for various query configuration parameters.\nCan be used to modify query behavior, including grand totals and zero-filling.", "type": "object", "properties": { "grandTotal": { "description": "Druid can include an extra \"grand totals\" row as the last row of a timeseries result set. To enable this, set \"grandTotal\" to true. The grand totals row will appear as the last row in the result array, and will have no timestamp. It will be the last row even if the query is run in \"descending\" mode. Post-aggregations in the grand totals row will be computed based upon the grand total aggregations.", "type": "boolean" }, "skipEmptyBuckets": { "description": "Timeseries queries normally fill empty interior time buckets with zeroes. Time buckets that lie completely outside the data interval are not zero-filled. You can disable all zero-filling with this flag. In this mode, the data point for empty buckets are omitted from the results.", "type": "boolean" }, "timeout": { "description": "Query timeout in milliseconds, beyond which unfinished queries will be cancelled.\n0 timeout means no timeout.", "type": "integer" }, "priority": { "description": "Query Priority. Queries with higher priority get precedence for computational resources.", "type": "integer" }, "queryId": { "description": "Unique identifier given to this query. If a query ID is set or known, this can be used to cancel the query.", "type": "string" }, "useCache": { "description": "Flag indicating whether to leverage the query cache for this query. When set to false, it disables reading from the query cache for this query. When set to true, Apache Druid uses druid.broker.cache.useCache or druid.historical.cache.useCache to determine whether or not to read from the query cache.", "type": "boolean" }, "populateCache": { "description": "Flag indicating whether to save the results of the query to the query cache. Primarily used for debugging. When set to false, it disables saving the results of this query to the query cache. When set to true, Druid uses druid.broker.cache.populateCache or druid.historical.cache.populateCache to determine whether or not to save the results of this query to the query cache.", "type": "boolean" }, "useResultLevelCache": { "description": "Flag indicating whether to leverage the result level cache for this query. When set to false, it disables reading from the query cache for this query. When set to true, Druid uses druid.broker.cache.useResultLevelCache to determine whether or not to read from the result-level query cache.", "type": "boolean" }, "populateResultLevelCache": { "description": "Flag indicating whether to save the results of the query to the result level cache. Primarily used for debugging. When set to false, it disables saving the results of this query to the query cache. When set to true, Druid uses druid.broker.cache.populateResultLevelCache to determine whether or not to save the results of this query to the result-level query cache.", "type": "boolean" }, "bySegment": { "description": "Return \"by segment\" results. Primarily used for debugging, setting it to true returns results associated with the data segment they came from.", "type": "boolean" }, "finalize": { "description": "Flag indicating whether to \"finalize\" aggregation results. Primarily used for debugging. For instance, the hyperUnique aggregator will return the full HyperLogLog sketch instead of the estimated cardinality when this flag is set to false.", "type": "boolean" }, "chunkPeriod": { "description": "At the Broker process level, long interval queries (of any type) may be broken into shorter interval queries to parallelize merging more than normal. Broken up queries will use a larger share of cluster resources, but, if you use groupBy \"v1, it may be able to complete faster as a result. Use ISO 8601 periods. For example, if this property is set to P1M (one month), then a query covering a year would be broken into 12 smaller queries. The broker uses its query processing executor service to initiate processing for query chunks, so make sure druid.processing.numThreads is configured appropriately on the broker. groupBy queries do not support chunkPeriod by default, although they do if using the legacy \"v1\" engine. This context is deprecated since it's only useful for groupBy \"v1\", and will be removed in the future releases.", "type": "string" }, "maxScatterGatherBytes": { "description": "Maximum number of bytes gathered from data processes such as Historicals and realtime processes to execute a query. This parameter can be used to further reduce maxScatterGatherBytes limit at query time.", "type": "integer" }, "maxQueuedBytes": { "description": "Maximum number of bytes queued per query before exerting backpressure on the channel to the data server. Similar to maxScatterGatherBytes, except unlike that configuration, this one will trigger backpressure rather than query failure. Zero means disabled.", "type": "integer" }, "serializeDateTimeAsLong": { "description": "If true, DateTime is serialized as long in the result returned by Broker and the data transportation between Broker and compute process.", "type": "boolean" }, "serializeDateTimeAsLongInner": { "description": "If true, DateTime is serialized as long in the data transportation between Broker and compute process.", "type": "boolean" }, "enableParallelMerge": { "description": "Enable parallel result merging on the Broker. Note that druid.processing.merge.useParallelMergePool must be enabled for this setting to be set to true.", "type": "boolean" }, "parallelMergeParallelism": { "description": "Maximum number of parallel threads to use for parallel result merging on the Broker.", "type": "integer" }, "parallelMergeInitialYieldRows": { "description": "Number of rows to yield per ForkJoinPool merge task for parallel result merging on the Broker, before forking off a new task to continue merging sequences.", "type": "integer" }, "parallelMergeSmallBatchRows": { "description": "Size of result batches to operate on in ForkJoinPool merge tasks for parallel result merging on the Broker.", "type": "integer" } } }, "telemetry.DruidTimeSeriesRequest": { "description": "These types of queries take a timeseries query object and return an array of JSON objects where each object represents a value asked for by the timeseries query.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseRequest" }, { "type": "object", "required": [ "dataSource", "intervals", "granularity" ], "properties": { "dataSource": { "description": "A String or Object defining the data source to query, very similar to a table in\na relational database. However, a query can also masquerade as a data source,\nproviding subquery-like functionality. Query data sources are currently supported\nonly by GroupBy queries. See [DataSource](https://druid.apache.org/docs/latest/querying/datasource.html) for more information.", "$ref": "#/components/schemas/telemetry.DruidDataSource" }, "descending": { "description": "Whether to make descending ordered result. Default is false(ascending).", "type": "boolean" }, "intervals": { "description": "A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.", "type": "array", "items": { "description": "A ISO-8601 time interval. The ISO 8601 interval is a representation of a time interval with optional UTC offset.", "type": "string" }, "example": [ "2020-01-01T00:00:00.000/2020-01-03T00:00:00.000", "2020-01-01T00:00:00.000Z/2020-01-03T00:00:00.000Z", "2007-03-01T13:00:00Z/2008-05-11T15:30:00Z", "2007-03-01T13:00:00Z/P1Y2M10DT2H30M", "P1Y2M10DT2H30M/2008-05-11T15:30:00Z" ] }, "granularity": { "$ref": "#/components/schemas/telemetry.DruidGranularity" }, "filter": { "$ref": "#/components/schemas/telemetry.DruidFilter" }, "aggregations": { "description": "Aggregation functions are used to summarize data in buckets. Summarization functions include counting rows, calculating the min/max/sum of metrics and retrieving the first/last value of metrics for each bucket. Additional summarization functions are available with extensions. If no aggregator is provided, the results will be empty for each bucket.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidAggregator" } }, "postAggregations": { "description": "Post-aggregations are specifications of processing that should happen on aggregated values as they come out of Apache Druid. If you include a post aggregation as part of a query, make sure to include all aggregators the post-aggregator requires.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidPostAggregator" } }, "virtualColumns": { "description": "Virtual columns are columns that are computed on the fly during query execution. It can potentially draw from multiple underlying columns, although a virtual column always presents itself as a single column. Virtual columns can be referenced by their output names to be used as dimensions or as inputs to filters and aggregators.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidVirtualColumn" } }, "limit": { "description": "An integer that limits the number of results. The default is unlimited.", "type": "integer", "format": "int32" }, "context": { "$ref": "#/components/schemas/telemetry.DruidQueryContext" } } } ] }, "telemetry.DruidTopNRequest": { "description": "TopN queries return a sorted set of results for the values in a given dimension according\nto some criteria. Conceptually, they can be thought of as an approximate GroupByQuery over\na single dimension with an Ordering spec. TopNs are much faster and resource efficient than\nGroupBys for this use case. These types of queries take a topN query object and return an\narray of JSON objects where each object represents a value asked for by the topN query.\nTopNs are approximate in that each data process will rank their top K results and only return\nthose top K results to the Broker. K, by default in Druid, is max(1000, threshold).\nIn practice, this means that if you ask for the top 1000 items ordered, the correctness of the\nfirst ~900 items will be 100%, and the ordering of the results after that is not guaranteed.\nTopNs can be made more accurate by increasing the threshold.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseRequest" }, { "type": "object", "required": [ "dataSource", "intervals", "granularity", "dimension", "threshold", "metric" ], "properties": { "dataSource": { "description": "A String or Object defining the data source to query, very similar to a table in\na relational database. However, a query can also masquerade as a data source,\nproviding subquery-like functionality. Query data sources are currently supported\nonly by GroupBy queries. See [DataSource](https://druid.apache.org/docs/latest/querying/datasource.html) for more information.", "$ref": "#/components/schemas/telemetry.DruidDataSource" }, "intervals": { "description": "A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.", "type": "array", "items": { "type": "string" } }, "granularity": { "$ref": "#/components/schemas/telemetry.DruidGranularity" }, "filter": { "$ref": "#/components/schemas/telemetry.DruidFilter" }, "aggregations": { "description": "Aggregation functions are used to summarize data in buckets. Summarization functions include counting rows, calculating the min/max/sum of metrics and retrieving the first/last value of metrics for each bucket. Additional summarization functions are available with extensions. If no aggregator is provided, the results will be empty for each bucket.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidAggregator" } }, "postAggregations": { "description": "Post-aggregations are specifications of processing that should happen on aggregated values as they come out of Apache Druid. If you include a post aggregation as part of a query, make sure to include all aggregators the post-aggregator requires.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidPostAggregator" } }, "virtualColumns": { "description": "Virtual columns are columns that are computed on the fly during query execution. It can potentially draw from multiple underlying columns, although a virtual column always presents itself as a single column. Virtual columns can be referenced by their output names to be used as dimensions or as inputs to filters and aggregators.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidVirtualColumn" } }, "dimension": { "description": "A String or JSON object defining the dimension that you want the top taken for.", "$ref": "#/components/schemas/telemetry.DruidDimensionSpec" }, "threshold": { "description": "An integer defining the N in the topN (i.e., how many results you want in the top list).", "type": "integer" }, "metric": { "description": "A String or JSON object specifying the metric to sort by for the top list.", "$ref": "#/components/schemas/telemetry.DruidTopNMetricSpec" }, "context": { "$ref": "#/components/schemas/telemetry.DruidQueryContext" } } } ] }, "telemetry.DruidGroupByRequest": { "description": "These types of Apache Druid queries take a groupBy query object and return an array of JSON objects\nwhere each object represents a grouping asked for by the query.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseRequest" }, { "type": "object", "required": [ "dataSource", "dimensions", "granularity", "intervals" ], "properties": { "dataSource": { "description": "A String or Object defining the data source to query, very similar to a table in\na relational database. However, a query can also masquerade as a data source,\nproviding subquery-like functionality. Query data sources are currently supported\nonly by GroupBy queries. See [DataSource](https://druid.apache.org/docs/latest/querying/datasource.html) for more information.", "$ref": "#/components/schemas/telemetry.DruidDataSource" }, "dimensions": { "description": "A JSON list of dimensions to do the groupBy over; or see DimensionSpec for ways to extract dimensions..", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidDimensionSpec" } }, "limitSpec": { "$ref": "#/components/schemas/telemetry.DruidDefaultLimitSpec" }, "having": { "$ref": "#/components/schemas/telemetry.DruidHavingFilter" }, "granularity": { "$ref": "#/components/schemas/telemetry.DruidGranularity" }, "filter": { "$ref": "#/components/schemas/telemetry.DruidFilter" }, "aggregations": { "description": "Aggregation functions are used to summarize data in buckets. Summarization functions include counting rows, calculating the min/max/sum of metrics and retrieving the first/last value of metrics for each bucket. Additional summarization functions are available with extensions. If no aggregator is provided, the results will be empty for each bucket.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidAggregator" } }, "postAggregations": { "description": "Post-aggregations are specifications of processing that should happen on aggregated values as they come out of Apache Druid. If you include a post aggregation as part of a query, make sure to include all aggregators the post-aggregator requires.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidPostAggregator" } }, "virtualColumns": { "description": "Virtual columns are columns that are computed on the fly during query execution. It can potentially draw from multiple underlying columns, although a virtual column always presents itself as a single column. Virtual columns can be referenced by their output names to be used as dimensions or as inputs to filters and aggregators.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidVirtualColumn" } }, "intervals": { "description": "A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.", "type": "array", "items": { "type": "string" } }, "subtotalsSpec": { "description": "A JSON array of arrays to return additional result sets for groupings of subsets of top level dimensions. The subtotals feature allows computation of multiple sub-groupings in a single query. To use this feature, add a \"subtotalsSpec\" to your query, which should be a list of subgroup dimension sets. It should contain the \"outputName\" from dimensions in your \"dimensions\" attribute, in the same order as they appear in the \"dimensions\" attribute.", "type": "object" }, "context": { "$ref": "#/components/schemas/telemetry.DruidQueryContext" } } } ] }, "telemetry.DruidScanRequest": { "description": "The Scan query returns raw Apache Druid rows in streaming mode.\nIn addition to straightforward usage where a Scan query is issued to the Broker, the Scan query\ncan also be issued directly to Historical processes or streaming ingestion tasks. This can be useful\nif you want to retrieve large amounts of data in parallel.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseRequest" }, { "type": "object", "required": [ "dataSource", "intervals" ], "properties": { "dataSource": { "description": "A String or Object defining the data source to query, very similar to a table in\na relational database. However, a query can also masquerade as a data source,\nproviding subquery-like functionality. Query data sources are currently supported\nonly by GroupBy queries. See [DataSource](https://druid.apache.org/docs/latest/querying/datasource.html) for more information.", "$ref": "#/components/schemas/telemetry.DruidDataSource" }, "intervals": { "description": "A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.", "type": "array", "items": { "type": "string" }, "example": [ "2020-01-01T00:00:00.000/2020-01-03T00:00:00.000" ] }, "resultFormat": { "description": "How the results are represented, list or compactedList.", "type": "string", "enum": [ "list", "compactedList" ], "default": "list" }, "filter": { "$ref": "#/components/schemas/telemetry.DruidFilter" }, "columns": { "description": "A String array of dimensions and metrics to scan. If left empty, all dimensions and metrics are returned.", "type": "array", "items": { "type": "string" } }, "batchSize": { "description": "The maximum number of rows buffered before being returned to the client.", "type": "integer", "default": 20480 }, "limit": { "description": "How many rows to return. If not specified, all rows will be returned.", "type": "integer", "format": "int32" }, "offset": { "description": "Skip this many rows when returning results. Skipped rows will still need to be generated internally and then discarded, meaning that raising offsets to high values can cause queries to use additional resources. Together, \"limit\" and \"offset\" can be used to implement pagination. However, note that if the underlying datasource is modified in between page fetches in ways that affect overall query results, then the different pages will not necessarily align with each other.", "type": "integer", "format": "int32" }, "order": { "description": "The ordering of returned rows based on timestamp. \"ascending\", \"descending\", and \"none\" (default) are supported. Currently, \"ascending\" and \"descending\" are only supported for queries where the __time column is included in the columns field and the requirements outlined in the time ordering section are met.", "type": "string", "enum": [ "none", "ascending", "descending" ], "default": "none" }, "legacy": { "description": "Return results consistent with the legacy \"scan-query\" contrib extension. Defaults to the value set by druid.query.scan.legacy, which in turn defaults to false.", "type": "boolean", "default": false }, "context": { "$ref": "#/components/schemas/telemetry.DruidQueryContext" }, "virtualColumns": { "description": "Virtual columns are columns that are computed on the fly during query execution. It can potentially draw from multiple underlying columns, although a virtual column always presents itself as a single column. Virtual columns can be referenced by their output names to be used as dimensions or as inputs to filters and aggregators.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidVirtualColumn" } } } } ] }, "telemetry.DruidSearchRequest": { "description": "These types of queries returns dimension values that match the search specification", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseRequest" }, { "type": "object", "required": [ "dataSource", "intervals", "granularity" ], "properties": { "dataSource": { "description": "A String or Object defining the data source to query, very similar to a table in\na relational database. However, a query can also masquerade as a data source,\nproviding subquery-like functionality. Query data sources are currently supported\nonly by GroupBy queries. See [DataSource](https://druid.apache.org/docs/latest/querying/datasource.html) for more information.", "$ref": "#/components/schemas/telemetry.DruidDataSource" }, "intervals": { "description": "A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over.", "type": "array", "items": { "description": "A ISO-8601 time interval. The ISO 8601 interval is a representation of a time interval with optional UTC offset.", "type": "string" }, "example": [ "2020-01-01T00:00:00.000/2020-01-03T00:00:00.000", "2020-01-01T00:00:00.000Z/2020-01-03T00:00:00.000Z", "2007-03-01T13:00:00Z/2008-05-11T15:30:00Z", "2007-03-01T13:00:00Z/P1Y2M10DT2H30M", "P1Y2M10DT2H30M/2008-05-11T15:30:00Z" ] }, "granularity": { "$ref": "#/components/schemas/telemetry.DruidGranularity" }, "filter": { "$ref": "#/components/schemas/telemetry.DruidFilter" }, "aggregations": { "description": "Aggregation functions are used to summarize data in buckets. Summarization functions include counting rows, calculating the min/max/sum of metrics and retrieving the first/last value of metrics for each bucket. Additional summarization functions are available with extensions. If no aggregator is provided, the results will be empty for each bucket.", "type": "array", "items": { "$ref": "#/components/schemas/telemetry.DruidAggregator" } }, "searchDimensions": { "description": "The list of dimensions to run the search over. Excluding this means the search is run over all dimensions.", "type": "array", "items": { "description": "Dimension name", "type": "string" } }, "query": { "$ref": "#/components/schemas/telemetry.DruidAggregateSearchSpec" }, "limit": { "description": "An integer that limits the number of results. The default is unlimited.", "type": "integer", "format": "int32" }, "context": { "$ref": "#/components/schemas/telemetry.DruidQueryContext" } } } ] }, "telemetry.DruidBaseSearchSpec": { "type": "object", "description": "The base structure for all Druid search specifications.", "required": [ "type" ], "properties": { "type": { "description": "Type of the search.", "type": "string", "enum": [ "insensitive_contains", "fragment", "contains", "regex" ] } } }, "telemetry.DruidAggregateSearchSpec": { "description": "Generic search specification descriptor", "oneOf": [ { "$ref": "#/components/schemas/telemetry.DruidInsensitiveContainsSearchSpec" }, { "$ref": "#/components/schemas/telemetry.DruidFragmentSearchSpec" }, { "$ref": "#/components/schemas/telemetry.DruidContainsSearchSpec" }, { "$ref": "#/components/schemas/telemetry.DruidRegexSearchSpec" } ], "discriminator": { "propertyName": "type", "mapping": { "insensitive_contains": "#/components/schemas/telemetry.DruidInsensitiveContainsSearchSpec", "fragment": "#/components/schemas/telemetry.DruidFragmentSearchSpec", "contains": "#/components/schemas/telemetry.DruidContainsSearchSpec", "regex": "#/components/schemas/telemetry.DruidRegexSearchSpec" } } }, "telemetry.DruidInsensitiveContainsSearchSpec": { "description": "The specification for a Druid 'insensitive_contains' search", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseSearchSpec" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "description": "The value to match. If any part of a dimension value contains the value specified in this search query spec, regardless of case, a \"match\" occurs.", "type": "string" } } } ] }, "telemetry.DruidFragmentSearchSpec": { "description": "The specification for a Druid 'insensitive_contains' search", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseSearchSpec" }, { "required": [ "values" ], "type": "object", "properties": { "values": { "description": "The value to match. If any part of a dimension value contains all of the values specified in this search query spec a \"match\" occurs.", "type": "array", "items": { "description": "Values to match", "type": "string" } }, "case_sensitive": { "description": "Whether or not search is case sensitive", "type": "boolean" } } } ] }, "telemetry.DruidContainsSearchSpec": { "description": "The specification for a Druid 'insensitive_contains' search", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseSearchSpec" }, { "required": [ "value" ], "type": "object", "properties": { "value": { "description": "The value to match. If any part of a dimension value contains the value specified in this search query spec, regardless of case, a \"match\" occurs.", "type": "string" }, "case_sensitive": { "description": "Whether or not search is case sensitive", "type": "boolean" } } } ] }, "telemetry.DruidRegexSearchSpec": { "description": "The specification for a Druid 'insensitive_contains' search", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseSearchSpec" }, { "required": [ "regex" ], "type": "object", "properties": { "regex": { "description": "The regular expression to match. If any part of a dimension value contains the pattern specified in this search query a \"match\" occurs.", "type": "string" } } } ] }, "telemetry.DruidTimeBoundaryRequest": { "description": "Time boundary queries return the earliest and latest data points of a data set.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseRequest" }, { "type": "object", "required": [ "dataSource" ], "properties": { "dataSource": { "description": "A String or Object defining the data source to query, very similar to a table in a relational database. See DataSource for more information.", "$ref": "#/components/schemas/telemetry.DruidDataSource" }, "bound": { "description": "Optional, set to maxTime or minTime to return only the latest or earliest timestamp. Default to returning both if not set.", "type": "string", "enum": [ "maxTime", "minTime" ] }, "filter": { "$ref": "#/components/schemas/telemetry.DruidFilter" }, "context": { "$ref": "#/components/schemas/telemetry.DruidQueryContext" } } } ] }, "telemetry.DruidSegmentMetadataRequest": { "description": "Time boundary queries return the earliest and latest data points of a data set.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseRequest" }, { "type": "object", "required": [ "dataSource" ], "properties": { "dataSource": { "description": "A String or Object defining the data source to query, very similar to a table in a relational database. See DataSource for more information.", "$ref": "#/components/schemas/telemetry.DruidDataSource" }, "intervals": { "description": "A JSON Object representing ISO-8601 Intervals. This defines the time ranges to run the query over. If an interval is not specified, the query will use a default interval that spans a configurable period before the end time of the most recent segment.", "type": "array", "items": { "type": "string" } }, "toInclude": { "description": "A JSON Object representing what columns should be included in the result. Defaults to \"all\".", "type": "object" }, "merge": { "description": "Merge all individual segment metadata results into a single result.", "type": "boolean" }, "context": { "$ref": "#/components/schemas/telemetry.DruidQueryContext" }, "analysisTypes": { "description": "A list of Strings specifying what column properties (e.g., cardinality, size) should be calculated and returned in the result. Defaults to [\"cardinality\", \"interval\", \"minmax\"], but can be overridden with using the segment metadata query config. * cardinality - in the result will return the estimated floor of cardinality for each column. Only relevant for dimension columns. * minmax - Estimated min/max values for each column. Only relevant for dimension columns. * size - in the result will contain the estimated total segment byte size as if the data were stored in text format. * intervals - in the result will contain the list of intervals associated with the queried segments. * timestampSpec - in the result will contain timestampSpec of data stored in segments. This can be null if timestampSpec of segments was unknown or unmergeable (if merging is enabled). * queryGranularity - in the result will contain query granularity of data stored in segments. This can be null if query granularity of segments was unknown or unmergeable (if merging is enabled). * aggregators - in the result will contain the list of aggregators usable for querying metric columns. This may be null if the aggregators are unknown or unmergeable (if merging is enabled). Merging can be strict or lenient. The form of the result is a map of column name to aggregator. * rollup - in the result is true/false/null. When merging is enabled, if some are rollup, others are not, result is null.", "type": "array", "items": { "type": "string" } }, "lenientAggregatorMerge": { "description": "If true, and if the \"aggregators\" analysisType is enabled, aggregators will be merged leniently.", "type": "boolean" } } } ] }, "telemetry.DruidDataSourceMetadataRequest": { "description": "Data Source Metadata queries return metadata information for a dataSource.\nThese queries return information about the timestamp of latest ingested event for the dataSource.\nThis is the ingested event without any consideration of rollup.", "allOf": [ { "$ref": "#/components/schemas/telemetry.DruidBaseRequest" }, { "type": "object", "required": [ "dataSource" ], "properties": { "dataSource": { "description": "A String or Object defining the data source to query, very similar to a table in a relational database. See DataSource for more information.", "$ref": "#/components/schemas/telemetry.DruidDataSource" }, "context": { "$ref": "#/components/schemas/telemetry.DruidQueryContext" } } } ] }, "search.SuggestItem.Response": { "description": "The response body of a HTTP GET request for the 'search.SuggesthItem' resource.", "x-one-of-name": "search.SuggestItem.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/search.SuggestItem.List" } ], "discriminator": { "propertyName": "ObjectType" } }, "search.SuggestItem": { "title": "search.SuggestItem resources", "description": "This resource is used to search for objects matching a criteria in the endpoint.", "allOf": [ { "type": "object" } ] }, "search.SuggestItem.List": { "title": "List of 'search.SuggestItem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'search.SuggestItem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'search.SuggestItem' resources matching the request.", "type": "array", "items": { "description": "A dimension value matching search query", "type": "object" } } } } ] }, "aaa.AbstractAuditRecord": { "title": "Aaa:Abstract Audit Record", "description": "AbstractAuditRecord is an abstract base type that specifies the common properties for all audit log records concrete sub-types.", "x-allOf-name": "aaa.AbstractAuditRecord", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.AbstractAuditRecord', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "aaa.AuditRecord" ], "default": "aaa.AuditRecord", "x-enum-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": [ "aaa.AuditRecord" ], "default": "aaa.AuditRecord", "x-enum-as-string": true }, "Event": { "description": "The operation that was performed on this Managed Object.\nThe event is a compound string that includes the CRUD operation such as Create, Modify, Delete, and a string representing the Managed Object type.", "type": "string", "readOnly": true, "x-omitempty": true }, "HttpOperation": { "description": "The REST URL for the operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "HttpResponseCode": { "description": "The response code of the operation.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HttpResponsePayload": { "description": "The response body of the operation, with JSON truncated to 2 nested levels when its size exceeds 10KB.", "nullable": true, "readOnly": true, "x-omitempty": true }, "MoDisplayNames": { "description": "The user-friendly names of the changed MO.", "nullable": true, "readOnly": true, "x-omitempty": true }, "MoType": { "description": "The object type of the REST resource that was created, modified or deleted.", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectMoid": { "description": "The Moid of the REST resource that was created, modified or deleted.", "type": "string", "readOnly": true, "x-omitempty": true }, "Request": { "description": "The body of the REST request that was received from a client to create or modify a REST resource, represented as a JSON document.", "nullable": true, "readOnly": true, "x-omitempty": true }, "TraceId": { "description": "The trace id of the request that was used to create, modify or delete a REST resource.\nA trace id is a unique identifier for one particular REST request. It may be used for troubleshooting purpose\nby the Intersight technical support team.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserAgent": { "description": "The parsed representation of the user agent of the request.", "$ref": "#/components/schemas/aaa.UserAgent", "readOnly": true, "x-omitempty": true }, "UserAgentString": { "description": "The raw, string representation of the user agent of the request from the user-agent http request header.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "aaa.AuditRecord.Response": { "description": "The response body of a HTTP GET request for the 'aaa.AuditRecord' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'aaa.AuditRecord' resources.", "x-one-of-name": "aaa.AuditRecord.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/aaa.AuditRecord.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "aaa.AuditRecord": { "title": "Aaa:Audit Record", "description": "The AuditRecord object is a crucial element within the system, providing a comprehensive overview of configuration changes made by users. It serves as a reliable log of actions, supporting transparency, accountability, and operational integrity.\n#### Purpose\nAn AuditRecord functions as a historical record of configuration changes, capturing essential details about modifications in real time. This ensures that all changes are traceable and can be reviewed for compliance and audit purposes.\n#### Key Concepts\n- **Transparency:** Provides visibility into user actions, ensuring all changes are logged with details such as timestamps, user identities, and affected objects.\n- **Accountability:** By documenting changes, AuditRecords promote accountability among users, encouraging responsible and informed decision-making.\n- **Access Control:** Access is governed by privilege sets, ensuring only authorized personnel can view audit logs and understand the context of changes.\n- **Relationship Management:** AuditRecords are associated with user accounts and sessions, allowing a detailed trace of who made changes and under what circumstances.", "x-allOf-name": "aaa.AuditRecord", "allOf": [ { "$ref": "#/components/schemas/aaa.AbstractAuditRecord" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.AuditRecord', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "aaa.AuditRecord" ], "default": "aaa.AuditRecord", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "aaa.AuditRecord" ], "default": "aaa.AuditRecord", "x-enum-as-string": true }, "AffectedObjectTypeLabel": { "description": "The user-friendly label for the object type that was changed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Email": { "description": "The email of the associated user that made the change. In case the user is later deleted, we still have some reference to the information.", "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 }, "InstId": { "description": "The instance id of AuditRecordLocal, which is used to identify if the comming AuditRecordLocal was already processed before.", "type": "string", "readOnly": true, "x-omitempty": true }, "SessionId": { "description": "The sessionId in which the user made the change. In case that the session is later deleted, we still have some reference to the information.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceIp": { "description": "The source IP of the client.", "type": "string", "readOnly": true, "x-omitempty": true }, "Timestamp": { "description": "The creation time of AuditRecordLocal, which is the time when the affected MO was created/modified/deleted.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "UserIdOrEmail": { "description": "The userId or the email of the associated user that made the change. In case that user is later deleted, we still have some reference to the information.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Sessions": { "$ref": "#/components/schemas/iam.Session.Relationship", "description": "A reference to a iamSession resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/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 } } } ] }, "aaa.AuditRecord.List": { "title": "List of 'aaa.AuditRecord' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'aaa.AuditRecord' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'aaa.AuditRecord' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/aaa.AuditRecord" }, "nullable": true } } } ] }, "aaa.RetentionConfig.Response": { "description": "The response body of a HTTP GET request for the 'aaa.RetentionConfig' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'aaa.RetentionConfig' resources.", "x-one-of-name": "aaa.RetentionConfig.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/aaa.RetentionConfig.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "aaa.RetentionConfig": { "title": "Aaa:Retention Config", "description": "The RetentionConfig object provides default configurations for audit log retention, offering a standardized approach to managing retention periods in the absence of specific policies.\n#### Purpose\nRetentionConfig serves as a baseline configuration for audit log retention, ensuring logs are preserved for a defined period by default when no explicit retention policy exists. This helps maintain consistent log management practices across the system.\n#### Key Concepts\n- **Default Settings:** Establishes default retention periods, ensuring systematic log retention even without custom policies.\n- **System Ownership:** Managed by the system to guarantee reliable and consistent application of retention settings across all accounts.\n- **Read-Only Access:** Designed for safe consumption, ensuring default configurations are applied without unauthorized modifications.\n- **Policy Integration:** Complements account-specific RetentionPolicies, harmonizing log retention across the system.", "x-allOf-name": "aaa.RetentionConfig", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.RetentionConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "aaa.RetentionConfig" ], "default": "aaa.RetentionConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "aaa.RetentionConfig" ], "default": "aaa.RetentionConfig", "x-enum-as-string": true }, "RetentionPeriod": { "description": "The default retention period in months for audit log retention for accounts without a retention policy.", "type": "integer", "format": "int64", "minimum": 6, "maximum": 48, "readOnly": true, "x-omitempty": true } } } ] }, "aaa.RetentionConfig.List": { "title": "List of 'aaa.RetentionConfig' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'aaa.RetentionConfig' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'aaa.RetentionConfig' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/aaa.RetentionConfig" }, "nullable": true } } } ] }, "aaa.RetentionPolicy.Response": { "description": "The response body of a HTTP GET request for the 'aaa.RetentionPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'aaa.RetentionPolicy' resources.", "x-one-of-name": "aaa.RetentionPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/aaa.RetentionPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "aaa.RetentionPolicy": { "title": "Audit Log Retention Policy", "description": "The RetentionPolicy object governs audit log retention policies at the account level, specifying the duration for which audit logs are preserved before automatic deletion.\n#### Purpose\nA RetentionPolicy defines the time frame for audit log retention, ensuring logs are kept for an appropriate duration to meet organizational and regulatory requirements. This facilitates systematic management of log retention, balancing storage needs with compliance obligations.\n#### Key Concepts\n- **Policy Management:** Allows administrators to define and update retention periods, providing flexibility for changing compliance needs.\n- **Automatic Cleanup:** Enables automatic log deletion based on retention periods, reducing manual overhead and ensuring efficient storage use.\n- **Access Control:** Privilege sets govern the creation, reading, and updating of RetentionPolicies, ensuring only authorized users can modify configurations.\n- **Account Association:** Each RetentionPolicy is linked to specific accounts, enabling tailored retention strategies for different organizational units.", "x-allOf-name": "aaa.RetentionPolicy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.RetentionPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "aaa.RetentionPolicy" ], "default": "aaa.RetentionPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "aaa.RetentionPolicy" ], "default": "aaa.RetentionPolicy", "x-enum-as-string": true }, "RetentionPeriod": { "description": "The time period in months for audit log retention. Audit logs beyond this period will be automatically deleted.", "type": "integer", "format": "int64", "maximum": 48, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "aaa.RetentionPolicy.List": { "title": "List of 'aaa.RetentionPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'aaa.RetentionPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'aaa.RetentionPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/aaa.RetentionPolicy" }, "nullable": true } } } ] }, "aaa.UserAgent": { "title": "Aaa:User Agent", "description": "A user agent of an API request. The user agent has information about the operating system family and version that initiated the request. The user agent also has information about the software client that made the request which includes the software type (browser, SDK, etc.) and version.", "x-allOf-name": "aaa.UserAgent", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'aaa.UserAgent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "aaa.UserAgent" ], "default": "aaa.UserAgent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "aaa.UserAgent" ], "default": "aaa.UserAgent", "x-enum-as-string": true }, "OsFamily": { "description": "The type of operating system that sent the request.\nNot applicable to Intersight SDK requests.", "type": "string", "readOnly": true, "x-omitempty": true }, "OsVersion": { "description": "The version of the operating system that sent the request.\nNot applicable for Intersight SDK requests.", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareFamily": { "description": "The type of client that made the request.\nFor browser requests, it is the specific browser that made the request (e.g. Chrome, Firefox, etc.).", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareSubtype": { "description": "The subtype of software that made the request.\nFor SDK requests, this is the programming language used in the SDK. For browser requests, this provides additional context on the client (e.g. if the client is running on a mobile device).", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareType": { "description": "The type of application that made the request.\nThis can be a browser or some other software, such as an SDK.", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareVersion": { "description": "The version of the client that made the request.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "apiproxy.AllowList.Response": { "description": "The response body of a HTTP GET request for the 'apiproxy.AllowList' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'apiproxy.AllowList' resources.", "x-one-of-name": "apiproxy.AllowList.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/apiproxy.AllowList.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "apiproxy.AllowList": { "title": "Apiproxy:Allow List", "description": "Object representing the platform's API Allow-List used by the casanova proxy server.", "x-allOf-name": "apiproxy.AllowList", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'apiproxy.AllowList', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "apiproxy.AllowList" ], "default": "apiproxy.AllowList", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "apiproxy.AllowList" ], "default": "apiproxy.AllowList", "x-enum-as-string": true }, "Platform": { "description": "Target platform this allow list is targeted to.\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 }, "Version": { "description": "Version of the allow list file.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "apiproxy.AllowList.List": { "title": "List of 'apiproxy.AllowList' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'apiproxy.AllowList' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'apiproxy.AllowList' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/apiproxy.AllowList" }, "nullable": true } } } ] }, "appliance.ApiStatus": { "title": "Appliance:Api Status", "description": "Status of an API. APIs are all get type and from ApiDocs.", "x-allOf-name": "appliance.ApiStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ApiStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ApiStatus" ], "default": "appliance.ApiStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ApiStatus" ], "default": "appliance.ApiStatus", "x-enum-as-string": true }, "ElapsedTime": { "description": "The elapsed time for query in seconds.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "ObjectName": { "description": "Name to identify the API.", "type": "string", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "Reason to address why the API call failed, if API call was successed, reason would be null.", "type": "string", "readOnly": true, "x-omitempty": true }, "Response": { "description": "Response code of the API call.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.AppOpStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.AppOpStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.AppOpStatus' resources.", "x-one-of-name": "appliance.AppOpStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.AppOpStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.AppOpStatus.Relationship": { "description": "A relationship to the 'appliance.AppOpStatus' resource, or the expanded 'appliance.AppOpStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.AppOpStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.AppOpStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.AppOpStatus": { "title": "Appliance:App Op Status", "description": "The AppOpStatus object articulates the operational status of applications running on the Intersight Appliance. It tracks the application's readiness and performance.\n#### Purpose\nAppOpStatus is crucial for assessing application-level health, monitoring metrics such as replica counts, restarts, and API statuses to ensure robust application functionality.\n#### Key Concepts\n- **Application Health:** Evaluates operational status, readiness, and performance, categorizing applications as Operational, AttentionNeeded, or Impaired.\n- **Replica Management:** Monitors the number of application instances provisioned and running to ensure adequate resources.\n- **Performance Tracking:** Keeps track of restarts and API statuses to maintain application stability and efficiency.", "x-allOf-name": "appliance.AppOpStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.AppOpStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.AppOpStatus" ], "default": "appliance.AppOpStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.AppOpStatus" ], "default": "appliance.AppOpStatus", "x-enum-as-string": true }, "ApiStatuses": { "type": "array", "items": { "description": "A collection of the apis status.", "$ref": "#/components/schemas/appliance.ApiStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AppLabel": { "description": "Unique label to identify the application.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the application.\nOperational status is based on the result of the status\nchecks. If result of any check is Critical, then its\nvalue is Impaired. Otherwise, if result of any check is\nWarning, then its value is AttentionNeeded. If all\nchecks are OK, then its value is Operational.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ReadyCount": { "description": "Number of replicas ready. The number of instances of\nthe application currently ready to perform its intended\nfunctions.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ReplicaCount": { "description": "Number of replicas provisioned. The number of instances\nof the application provisioned to run on the Intersight appliance.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RestartCount1Hour": { "description": "Number of instance restarts in the last hour.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RestartCount24Hours": { "description": "Number of instance restarts in the last 24 hours.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RestartCount5Mins": { "description": "Number of instance restarts in the last 5 minutes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RestartCountTotal": { "description": "Total number of restarts since last deployment.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RunningCount": { "description": "Number of replicas running. The number of instances of\nthe application currently running.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "GroupOpStatus": { "$ref": "#/components/schemas/appliance.GroupOpStatus.Relationship", "description": "A reference to a applianceGroupOpStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SystemOpStatus": { "$ref": "#/components/schemas/appliance.SystemOpStatus.Relationship", "description": "A reference to a applianceSystemOpStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.AppOpStatus.List": { "title": "List of 'appliance.AppOpStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.AppOpStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.AppOpStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.AppOpStatus" }, "nullable": true } } } ] }, "appliance.AppStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.AppStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.AppStatus' resources.", "x-one-of-name": "appliance.AppStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.AppStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.AppStatus.Relationship": { "description": "A relationship to the 'appliance.AppStatus' resource, or the expanded 'appliance.AppStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.AppStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.AppStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.AppStatus": { "title": "Appliance:App Status", "description": "Status of an application.", "x-allOf-name": "appliance.AppStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.AppStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.AppStatus" ], "default": "appliance.AppStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.AppStatus" ], "default": "appliance.AppStatus", "x-enum-as-string": true }, "ApiStatuses": { "type": "array", "items": { "description": "A collection of the apis status.", "$ref": "#/components/schemas/appliance.ApiStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AppLabel": { "description": "Unique label to identify the application.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the application.\nOperational status is based on the result of the status\nchecks. If result of any check is Critical, then its\nvalue is Impaired. Otherwise, if result of any check is\nWarning, then its value is AttentionNeeded. If all\nchecks are OK, then its value is Operational.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ReadyCount": { "description": "Number of replicas ready. The number of instances of\nthe application currently ready to perform its intended\nfunctions.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ReplicaCount": { "description": "Number of replicas provisioned. The number of instances\nof the application provisioned to run on the Intersight appliance.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RestartCount1Hour": { "description": "Number of instance restarts in the last hour.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RestartCount24Hours": { "description": "Number of instance restarts in the last 24 hours.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RestartCount5Mins": { "description": "Number of instance restarts in the last 5 minutes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RestartCountTotal": { "description": "Total number of restarts since last deployment.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RunningCount": { "description": "Number of replicas running. The number of instances of\nthe application currently running.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StatusChecks": { "type": "array", "items": { "description": "A collection of the status checks performed.", "$ref": "#/components/schemas/appliance.StatusCheck", "readOnly": true, "x-omitempty": true }, "nullable": true }, "GroupStatus": { "$ref": "#/components/schemas/appliance.GroupStatus.Relationship", "description": "A reference to a applianceGroupStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SystemStatus": { "$ref": "#/components/schemas/appliance.SystemStatus.Relationship", "description": "A reference to a applianceSystemStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.AppStatus.List": { "title": "List of 'appliance.AppStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.AppStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.AppStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.AppStatus" }, "nullable": true } } } ] }, "appliance.AutoRmaPolicy.Response": { "description": "The response body of a HTTP GET request for the 'appliance.AutoRmaPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.AutoRmaPolicy' resources.", "x-one-of-name": "appliance.AutoRmaPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.AutoRmaPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.AutoRmaPolicy": { "title": "Appliance:Auto Rma Policy", "description": "Auto rma policy to decide whether rma data should be collected.", "x-allOf-name": "appliance.AutoRmaPolicy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.AutoRmaPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.AutoRmaPolicy" ], "default": "appliance.AutoRmaPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.AutoRmaPolicy" ], "default": "appliance.AutoRmaPolicy", "x-enum-as-string": true }, "Enable": { "description": "Status of the data collection mode. If the value is 'true', then data collection is enabled.", "type": "boolean", "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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." } } } ] }, "appliance.AutoRmaPolicy.List": { "title": "List of 'appliance.AutoRmaPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.AutoRmaPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.AutoRmaPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.AutoRmaPolicy" }, "nullable": true } } } ] }, "appliance.Backup.Response": { "description": "The response body of a HTTP GET request for the 'appliance.Backup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.Backup' resources.", "x-one-of-name": "appliance.Backup.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.Backup.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.Backup.Relationship": { "description": "A relationship to the 'appliance.Backup' resource, or the expanded 'appliance.Backup' resource, or the 'null' value.", "x-one-of-name": "appliance.Backup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.Backup" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.Backup": { "title": "Appliance:Backup", "description": "The Backup object is essential for managing system backups, ensuring data integrity and continuity through structured backup requests and processes.\n#### Purpose\nThe Backup object oversees the creation and tracking of system backups, facilitating comprehensive data protection strategies through monitored backup operations.\n#### Key Concepts\n- **Managed States:** Enables tracking of backup states from initiation to completion, ensuring the integrity and availability of system data.\n- **Single Active Instance:** Maintains one active backup instance at any given time to streamline operations and avoid conflicts.\n- **Manual and Scheduled Modes:** Supports both manual and scheduled backup requests, accommodating diverse operational needs.\n- **Account Relationships:** Integrates with account management for secure and organized backup processes.", "x-allOf-name": "appliance.Backup", "allOf": [ { "$ref": "#/components/schemas/appliance.BackupBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.Backup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.Backup" ], "default": "appliance.Backup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.Backup" ], "default": "appliance.Backup", "x-enum-as-string": true }, "BackupDownloadUrl": { "description": "Download URL for the backup artifact when available. Only populated for successful local-protocol backups; empty for remote-protocol backups.", "type": "string", "readOnly": true, "x-omitempty": true }, "ElapsedTime": { "description": "Elapsed time in seconds since the backup process has started.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date and time of the backup process.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ForceDelete": { "description": "Set to true to allow deletion of the oldest local backup when local backup retention limit is reached. If false and retention count is reached, the backup operation fails.", "type": "boolean", "x-omitempty": true }, "IsManual": { "description": "If true, represents a manual backup. Else represents a scheduled backup.", "type": "boolean", "readOnly": true, "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 }, "Messages": { "type": "array", "items": { "description": "Messages generated during the backup process.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Password": { "description": "Password to authenticate the fileserver.", "type": "string", "pattern": "^$|^[^`]+$", "writeOnly": true, "x-omitempty": true }, "StartTime": { "description": "Start date and time of the backup process.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the backup managed object.\n* `Started` - Backup or restore process has started.\n* `Created` - Backup or restore is in created state.\n* `Failed` - Backup or restore process has failed.\n* `Completed` - Backup or restore process has completed.\n* `Copied` - Backup file has been copied.\n* `Cleanup Failed` - Cleanup of the old backup has failed.", "type": "string", "enum": [ "Started", "Created", "Failed", "Completed", "Copied", "Cleanup Failed" ], "default": "Started", "readOnly": true, "x-omitempty": true }, "UsePolicySettings": { "description": "Set to true to inherit credentials, protocol, and file server settings from the appliance backup policy. If false, use explicit settings provided in this backup object.", "type": "boolean", "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.Backup.List": { "title": "List of 'appliance.Backup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.Backup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.Backup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.Backup" }, "nullable": true } } } ] }, "appliance.BackupBase": { "title": "Appliance:Backup Base", "description": "BackupBase is the parent type of Backup, Restore, and BackupPolicy managed objects.\nBackupBase holds the common information required for copying the file from the\nIntersight Appliance to the remote file server and vice versa.", "x-allOf-name": "appliance.BackupBase", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.BackupBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "appliance.Backup", "appliance.BackupPolicy", "appliance.BackupRotateData", "appliance.Restore" ], "x-enum-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": [ "appliance.Backup", "appliance.BackupPolicy", "appliance.BackupRotateData", "appliance.Restore" ], "x-enum-as-string": true }, "Filename": { "description": "Backup filename to backup or restore.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9_\\.\\-\\+]*$", "x-omitempty": true }, "Protocol": { "description": "Communication protocol used by backup and restore workflow (e.g. scp, sftp, cifs, or local).\n* `scp` - Secure Copy Protocol (SCP) to access the file server.\n* `sftp` - SSH File Transfer Protocol (SFTP) to access file server.\n* `cifs` - Common Internet File System (CIFS) Protocol to access file server.\n* `local` - Backup file is stored in Intersight Appliance.", "type": "string", "enum": [ "scp", "sftp", "cifs", "local" ], "default": "scp", "x-omitempty": true }, "RemoteHost": { "description": "Hostname of the remote file server. Not required when protocol is local.", "type": "string", "x-omitempty": true }, "RemotePath": { "description": "File server directory or share name to copy the file. Not required when protocol is local.", "type": "string", "pattern": "^$|^[^`]+$", "x-omitempty": true }, "RemotePort": { "description": "Remote TCP port on the file server (e.g. 22 for scp). Not required when protocol is local.", "type": "integer", "format": "int64", "x-omitempty": true }, "Username": { "description": "Username to authenticate the fileserver. Not required when protocol is local.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_][a-zA-Z0-9_\\.\\@\\\\\\-\\+]*$", "x-omitempty": true } } } ] }, "appliance.BackupDownload.Response": { "description": "The response body of a HTTP GET request for the 'appliance.BackupDownload' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.BackupDownload' resources.", "x-one-of-name": "appliance.BackupDownload.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.BackupDownload.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.BackupDownload": { "title": "Appliance:Backup Download", "description": "The BackupDownload object represents the download of a backup file, providing a secure and efficient mechanism for retrieving backup artifacts.\n#### Purpose\nThe BackupDownload object manages the download process of backup files, ensuring secure access and efficient retrieval of backup data for recovery or archival purposes.\n#### Key Concepts\n- **Artifact Access:** Provides a standardized method to download the specific backup file generated by the system.\n- **Integration:** Works in tandem with the Backup object to ensure that only validated and successful backups are made available for download.\n- **Security:** Enforces access controls to ensure that only authorized users can download system backup files.", "x-allOf-name": "appliance.BackupDownload", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.BackupDownload', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.BackupDownload" ], "default": "appliance.BackupDownload", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.BackupDownload" ], "default": "appliance.BackupDownload", "x-enum-as-string": true }, "Backup": { "$ref": "#/components/schemas/appliance.Backup.Relationship", "description": "A reference to a applianceBackup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.BackupDownload.List": { "title": "List of 'appliance.BackupDownload' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.BackupDownload' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.BackupDownload' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.BackupDownload" }, "nullable": true } } } ] }, "appliance.BackupMonitor.Response": { "description": "The response body of a HTTP GET request for the 'appliance.BackupMonitor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.BackupMonitor' resources.", "x-one-of-name": "appliance.BackupMonitor.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.BackupMonitor.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.BackupMonitor": { "title": "Appliance:Backup Monitor", "description": "The BackupMonitor object plays a pivotal role in overseeing the history and status of backup operations, ensuring ongoing data protection and system reliability.\nPurpose\nBackupMonitor tracks backup activities, providing a clear overview of the backup status and alerting users to potential issues or outdated backups.\n#### Key Concepts\n- **Status Tracking:** Monitors the success, failure, and currency of backups, offering timely feedback on data protection health.\n- **Alarm Integration:** Works in conjunction with alarm definitions to alert users to backup failures or outdated processes, ensuring proactive management.\n- **System-Oriented:** Designed for automated, system-driven monitoring, enhancing operational efficiency and reliability.\n- **Account Integration:** Connects seamlessly with account structures for consistent and secure monitoring operations.", "x-allOf-name": "appliance.BackupMonitor", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.BackupMonitor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.BackupMonitor" ], "default": "appliance.BackupMonitor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.BackupMonitor" ], "default": "appliance.BackupMonitor", "x-enum-as-string": true }, "Filename": { "description": "Filename of the backup for the backup monitor.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastBackupRotationStatus": { "description": "Status of the oldest Intersight Appliance backup cleanup.\n* `BackupFound` - Backup is successful and complete.\n* `BackupFailed` - The current Backup failed.\n* `BackupOutdated` - Backup is old and outdated.\n* `BackupCleanupFailed` - Cleanup of the old backup has failed.", "type": "string", "enum": [ "BackupFound", "BackupFailed", "BackupOutdated", "BackupCleanupFailed" ], "default": "BackupFound", "readOnly": true, "x-omitempty": true }, "LastBackupStatus": { "description": "Status of the most recent Intersight Appliance backup.\n* `BackupFound` - Backup is successful and complete.\n* `BackupFailed` - The current Backup failed.\n* `BackupOutdated` - Backup is old and outdated.\n* `BackupCleanupFailed` - Cleanup of the old backup has failed.", "type": "string", "enum": [ "BackupFound", "BackupFailed", "BackupOutdated", "BackupCleanupFailed" ], "default": "BackupFound", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.BackupMonitor.List": { "title": "List of 'appliance.BackupMonitor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.BackupMonitor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.BackupMonitor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.BackupMonitor" }, "nullable": true } } } ] }, "appliance.BackupPolicy.Response": { "description": "The response body of a HTTP GET request for the 'appliance.BackupPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.BackupPolicy' resources.", "x-one-of-name": "appliance.BackupPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.BackupPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.BackupPolicy": { "title": "Appliance:Backup Policy", "description": "The BackupPolicy object defines the strategic approach to system backups, setting guidelines and parameters for regular data protection operations.\n#### Purpose\nBackupPolicy establishes the backup framework, detailing the schedule, retention, and manual operation modes to ensure comprehensive data safeguarding.\n#### Key Concepts\n- **Policy Definition:** Outlines the backup strategy, including schedules and retention policies, facilitating organized and predictable backup operations.\n- **Manual and Automatic Modes:** Supports user-defined backup modes, allowing flexibility in data protection management.\n- **Retention Strategies:** Specifies retention policies to manage backup data lifecycle, promoting efficient storage use and data integrity.\n- **Organizational Alignment:** Ensures backup operations align with organizational goals and security standards, promoting reliable data management.", "x-allOf-name": "appliance.BackupPolicy", "allOf": [ { "$ref": "#/components/schemas/appliance.BackupBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.BackupPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.BackupPolicy" ], "default": "appliance.BackupPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.BackupPolicy" ], "default": "appliance.BackupPolicy", "x-enum-as-string": true }, "BackupTime": { "description": "The next backup time set by the backup scheduler. Backup scheduler calculates the next backup time with the user-defined schedule set in the Schedule field.", "type": "string", "format": "date-time", "readOnly": true, "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 }, "ManualBackup": { "description": "Backup mode of the appliance. Automatic backups of the appliance are not initiated if this property is set to 'true' and the backup schedule field is ignored.", "type": "boolean", "x-omitempty": true }, "Password": { "description": "Password to authenticate the file server.", "type": "string", "pattern": "^$|^[^`]+$", "writeOnly": true, "x-omitempty": true }, "RetentionCount": { "description": "The number of backups before earliest backup is overwritten. Requires cleanup policy to be enabled.", "type": "integer", "format": "int64", "default": 1, "x-omitempty": true }, "RetentionPolicyEnabled": { "description": "If backup rotate policy is set, older backups will automatically be overwritten. The number of backups before overwriting is defined by the retentionCount property.", "type": "boolean", "x-omitempty": true }, "Schedule": { "description": "Schedule to create a backup of the Intersight Appliance. Manualbackup field must be set to 'false' for this schedule to be active.", "$ref": "#/components/schemas/onprem.Schedule", "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.BackupPolicy.List": { "title": "List of 'appliance.BackupPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.BackupPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.BackupPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.BackupPolicy" }, "nullable": true } } } ] }, "appliance.BackupRotateData.Response": { "description": "The response body of a HTTP GET request for the 'appliance.BackupRotateData' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.BackupRotateData' resources.", "x-one-of-name": "appliance.BackupRotateData.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.BackupRotateData.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.BackupRotateData": { "title": "Appliance:Backup Rotate Data", "description": "BackupRotateData tracks the set of current backups being managed under a backup rotation policy. It serves as the system\u2019s record for actively managing backups during rotation, including when each backup was taken and which account scope it belongs to.\n#### Purpose\nMaintain rotation-aware backup bookkeeping so the platform can manage, retain, and rotate backups according to policy while providing read-only visibility into the backups currently under rotation management.\n#### Key Concepts\n- **Rotation management record**: Represents backups that are actively managed as part of a backup rotation process.\n- **Backup timestamping**: `backupTime` captures when the backup was taken, enabling ordering and retention/rotation decisions.\n- **Account-scoped ownership**: The `account` relationship ties the record to an `iam.Account`, and deletion of the account cascades to these records.\n- **Permission inheritance**: Inherits permissions from `account`, ensuring access aligns with account-level authorization.\n- **Read-only observability**: Exposed via READ for visibility; typically maintained by internal backup/rotation workflows rather than end-user CRUD operations.", "x-allOf-name": "appliance.BackupRotateData", "allOf": [ { "$ref": "#/components/schemas/appliance.BackupBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.BackupRotateData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.BackupRotateData" ], "default": "appliance.BackupRotateData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.BackupRotateData" ], "default": "appliance.BackupRotateData", "x-enum-as-string": true }, "BackupTime": { "description": "The time at which the backup was taken.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.BackupRotateData.List": { "title": "List of 'appliance.BackupRotateData' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.BackupRotateData' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.BackupRotateData' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.BackupRotateData" }, "nullable": true } } } ] }, "appliance.CertRenewalPhase": { "title": "Appliance:Cert Renewal Phase", "description": "CertRenewalPhase represents a phase of the Intersight Appliance certificate renewal\nprocess.", "x-allOf-name": "appliance.CertRenewalPhase", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.CertRenewalPhase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.CertRenewalPhase" ], "default": "appliance.CertRenewalPhase", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.CertRenewalPhase" ], "default": "appliance.CertRenewalPhase", "x-enum-as-string": true }, "EndTime": { "description": "End date of the certificate renewal phase.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Failed": { "description": "Indicates if the certificate renewal phase has failed or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Message": { "description": "Status message set during the certificate renewal phase.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the certificate renewal phase.\n* `Init` - New certificate detected, cleanup the old process if any running.\n* `ScheduleCertificateAddOperation` - Certificate Add Operation Schedulled.\n* `WaitForCertCollectionByEndpoint` - Monitor cert collection by endpoint.\n* `Success` - Certificate Renewal Task Success.\n* `Fail` - Certificate Renewal Task Fail.\n* `Cancel` - Certificate Renewal Task Cancel.", "type": "string", "enum": [ "Init", "ScheduleCertificateAddOperation", "WaitForCertCollectionByEndpoint", "Success", "Fail", "Cancel" ], "default": "Init", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "Start date of the certificate renewal phase.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.CertificateSetting.Response": { "description": "The response body of a HTTP GET request for the 'appliance.CertificateSetting' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.CertificateSetting' resources.", "x-one-of-name": "appliance.CertificateSetting.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.CertificateSetting.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.CertificateSetting": { "title": "Appliance:Certificate Setting", "description": "The CertificateSetting object manages the certificate used by the Intersight Appliance for browser traffic. It ensures secure communication between the appliance and external interfaces.\n#### Purpose\nCertificateSetting facilitates the management of certificates used for secure browser interactions. This provides administrators with the ability to update and manage the appliance's certificates, ensuring compliance with security standards.\n#### Key Concepts\n- **Security Management:** Enables secure handling of browser certificates, supporting encrypted communication.\n- **Access Control:** Restricted to account administrators, ensuring that certificate management is conducted securely.\n- **Integration with Accounts:** Establishes relationships with accounts, aligning certificate settings with account management.", "x-allOf-name": "appliance.CertificateSetting", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.CertificateSetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.CertificateSetting" ], "default": "appliance.CertificateSetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.CertificateSetting" ], "default": "appliance.CertificateSetting", "x-enum-as-string": true }, "Account": { "$ref": "#/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 }, "Certificate": { "$ref": "#/components/schemas/iam.Certificate.Relationship", "description": "A reference to a iamCertificate resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "appliance.CertificateSetting.List": { "title": "List of 'appliance.CertificateSetting' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.CertificateSetting' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.CertificateSetting' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.CertificateSetting" }, "nullable": true } } } ] }, "appliance.ClusterInfo.Response": { "description": "The response body of a HTTP GET request for the 'appliance.ClusterInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.ClusterInfo' resources.", "x-one-of-name": "appliance.ClusterInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.ClusterInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.ClusterInfo": { "title": "Appliance:Cluster Info", "description": "ClusterInfo model is used for a peer appliance to create a cluster with an existing, fully configured\nappliance.", "x-allOf-name": "appliance.ClusterInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ClusterInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ClusterInfo" ], "default": "appliance.ClusterInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ClusterInfo" ], "default": "appliance.ClusterInfo", "x-enum-as-string": true }, "BuildType": { "description": "The build type of the Intersight Virtual Appliance.", "type": "string", "x-omitempty": true }, "DeploymentSize": { "description": "The deployment size of the node requiring to join cluster.", "type": "string", "x-omitempty": true }, "Gateway": { "description": "Default gateway configured on the peer node.", "type": "string", "x-omitempty": true }, "Hostip": { "description": "Publicly accessible IP of the peer node.", "type": "string", "x-omitempty": true }, "Hostname": { "description": "Publicly accessible FQDN of the peer node.", "type": "string", "x-omitempty": true }, "HypervisorType": { "description": "The hypervisor type of the node.\n* `ESXi` - VMware ESXi hypervisor type.Indicates the appliance node is running on a VMware ESXi virtualization platform.\n* `Hyper-V` - Microsoft Hyper-V hypervisor type.Indicates the appliance node is running on a Microsoft Hyper-V virtualization platform.\n* `KVM` - Kernel-based Virtual Machine hypervisor type.Indicates the appliance node is running on a KVM virtualization platform.", "type": "string", "enum": [ "ESXi", "Hyper-V", "KVM" ], "default": "ESXi", "x-omitempty": true }, "InstallerVersion": { "description": "Installer version used to install on peer node.", "type": "string", "x-omitempty": true }, "NodeId": { "description": "System assigned unique ID of the Intersight Appliance node. The system incrementally assigns identifiers to each node in the Intersight Appliance starting with a value of 0.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NodeType": { "description": "The node type of Intersight Virtual Appliance.\n* `standalone` - Single Node Intersight Virtual Appliance.\n* `management` - Management node type when Intersight Virtual Appliance is running as management-worker deployment.\n* `hamanagement` - Management node type when Intersight Virtual Appliance is running as multi node HA deployment.\n* `metrics` - Metrics node when Intersight Virtual Appliance is running management-metrics node.", "type": "string", "enum": [ "standalone", "management", "hamanagement", "metrics" ], "default": "standalone", "x-omitempty": true }, "PartitionDatabase": { "description": "The partition size for /opt/database of this node.", "type": "integer", "format": "int64", "x-omitempty": true }, "PartitionFileCisco": { "description": "The partition size for /Cisco of this node.", "type": "integer", "format": "int64", "x-omitempty": true }, "PartitionOptData": { "description": "The partition size for /opt/cisco/data of this node.", "type": "integer", "format": "int64", "x-omitempty": true }, "PartitionOptKafka": { "description": "The partition size for /opt/kafka of this node.", "type": "integer", "format": "int64", "x-omitempty": true }, "PartitionOptMongo": { "description": "The partition size for /opt/mongodb of this node.", "type": "integer", "format": "int64", "x-omitempty": true }, "PartitionVarLibDocker": { "description": "The partition size for /var/lib/docker of this node.", "type": "integer", "format": "int64", "x-omitempty": true }, "PartitionVarLog": { "description": "The partition size for /var of this node.", "type": "integer", "format": "int64", "x-omitempty": true }, "Peerkey": { "description": "The public key of peer host.", "type": "string", "x-omitempty": true }, "Responsekey": { "description": "Public key returned to the client.", "type": "string", "x-omitempty": true }, "SignedManifest": { "description": "The signed manifest content for verifying integrity of cluster artifacts.", "type": "string", "format": "byte", "writeOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the cluster join process.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Subnetmask": { "description": "Subnet Mask of the peer node.", "type": "string", "x-omitempty": true }, "Uuid": { "description": "The UUID of the peer appliance.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.ClusterInfo.List": { "title": "List of 'appliance.ClusterInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.ClusterInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.ClusterInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.ClusterInfo" }, "nullable": true } } } ] }, "appliance.ClusterInstall.Response": { "description": "The response body of a HTTP GET request for the 'appliance.ClusterInstall' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.ClusterInstall' resources.", "x-one-of-name": "appliance.ClusterInstall.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.ClusterInstall.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.ClusterInstall": { "title": "Appliance:Cluster Install", "description": "ClusterInstall is a singleton that tracks the Intersight Appliance's install of two additional nodes.", "x-allOf-name": "appliance.ClusterInstall", "allOf": [ { "$ref": "#/components/schemas/appliance.ClusterInstallBase" } ] }, "appliance.ClusterInstall.List": { "title": "List of 'appliance.ClusterInstall' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.ClusterInstall' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.ClusterInstall' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.ClusterInstall" }, "nullable": true } } } ] }, "appliance.ClusterInstallBase": { "title": "Appliance:Cluster Install Base", "description": "MultinodeInstall is a singleton that tracks the Intersight Appliance's install of two additional nodes.", "x-allOf-name": "appliance.ClusterInstallBase", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ClusterInstallBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "appliance.ClusterInstall", "appliance.ClusterReplaceNode", "appliance.ClusterWorkerNode" ], "x-enum-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": [ "appliance.ClusterInstall", "appliance.ClusterReplaceNode", "appliance.ClusterWorkerNode" ], "x-enum-as-string": true }, "CompletedPhases": { "type": "array", "items": { "description": "Collection of the completed software install phases.", "$ref": "#/components/schemas/appliance.ClusterInstallPhase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "CurrentPhase": { "description": "Current phase of the Intersight Appliance's software install.", "$ref": "#/components/schemas/appliance.ClusterInstallPhase", "readOnly": true, "x-omitempty": true }, "ElapsedTime": { "description": "Elapsed time in seconds during the software install.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date of the software install.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ErrorCode": { "description": "Error code for Intersight Appliance's software install. In case of failure - this code will help decide if software install can be retried.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Messages": { "type": "array", "items": { "description": "Messages generated during the software install process.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NodeInfo": { "type": "array", "items": { "description": "Node ip info, which contains the ip addresses and hostnames of the other cluster nodes.", "$ref": "#/components/schemas/appliance.NodeIpInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RemoteDns": { "description": "Round robin DNS address, which should be able to resolve the hostnames of all the nodes in the cluster.", "type": "string", "x-omitempty": true }, "StartTime": { "description": "Start date of the software install. UI can modify startTime to re-schedule an install.", "type": "string", "format": "date-time", "x-omitempty": true }, "Status": { "description": "Status of the Intersight Appliance's software install.\n* `NotReady` - Cluster is not ready. Install cannot be triggered.\n* `Ready` - Cluster is ready. Install can be triggered.\n* `InProgress` - Install is currently in progress.\n* `Success` - Install was run and succeeded.\n* `Fail` - Install was run and failed.", "type": "string", "enum": [ "NotReady", "Ready", "InProgress", "Success", "Fail" ], "default": "NotReady", "readOnly": true, "x-omitempty": true }, "TotalNodes": { "description": "Total number of nodes in the system.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalPhases": { "description": "TotalPhase represents the total number of the install phases for one install.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Vip": { "description": "VIP hostname and ip address of the onprem cluster.", "$ref": "#/components/schemas/appliance.NodeIpInfo", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.ClusterInstallPhase": { "title": "Appliance:Cluster Install Phase", "description": "A phase in the Intersight Appliance cluster installation life cycle.", "x-allOf-name": "appliance.ClusterInstallPhase", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ClusterInstallPhase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ClusterInstallPhase" ], "default": "appliance.ClusterInstallPhase", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ClusterInstallPhase" ], "default": "appliance.ClusterInstallPhase", "x-enum-as-string": true }, "CurrentNode": { "description": "Node number install is running on.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CurrentSubphase": { "description": "Subphase of the phase currently running.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ElapsedTime": { "description": "Elapsed time in seconds to complete the current install phase.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date of the software install phase.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Failed": { "description": "Indicates if the install phase has failed or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Message": { "description": "Status message set during the install phase.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the install phase.\n* `Backup` - Backup the currently running node.\n* `EnableBootstrap` - Disable echo and enable nginx on the currently running node.\n* `UpdateAnsibleHosts` - Update /etc/ansible/hosts on each node.\n* `UpdateNetworkConfig` - Update Network config for node IP change scenario.\n* `SyncImages` - Sync images and manifest to each node.\n* `ConfigureEtcd` - Configure etcd on each node.\n* `DeployServices` - Deploy kubernetes services from node 1.\n* `InstallEquinox` - Configure and install equinox on each node.\n* `Validate` - Validate equinox is running in primary/secondary mode.\n* `CheckApplianceClusterState` - Check the appliance cluster status.\n* `Success` - Upgrade completed successfully.\n* `Fail` - Indicates that the upgrade process has failed.\n* `Cancel` - Indicates that the upgrade was canceled by the Intersight Appliance.", "type": "string", "enum": [ "Backup", "EnableBootstrap", "UpdateAnsibleHosts", "UpdateNetworkConfig", "SyncImages", "ConfigureEtcd", "DeployServices", "InstallEquinox", "Validate", "CheckApplianceClusterState", "Success", "Fail", "Cancel" ], "default": "Backup", "readOnly": true, "x-omitempty": true }, "PendingNodes": { "type": "array", "items": { "description": "Node number install is pending.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "nullable": true }, "StartTime": { "description": "Start date of the software install phase.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the install phase.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.ClusterReplaceNode.Response": { "description": "The response body of a HTTP GET request for the 'appliance.ClusterReplaceNode' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.ClusterReplaceNode' resources.", "x-one-of-name": "appliance.ClusterReplaceNode.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.ClusterReplaceNode.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.ClusterReplaceNode": { "title": "Appliance:Cluster Replace Node", "description": "ClusterReplaceNode is a singleton that tracks the Intersight Appliance's process for replacing a cluster node.", "x-allOf-name": "appliance.ClusterReplaceNode", "allOf": [ { "$ref": "#/components/schemas/appliance.ClusterInstallBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ClusterReplaceNode', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ClusterReplaceNode" ], "default": "appliance.ClusterReplaceNode", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ClusterReplaceNode" ], "default": "appliance.ClusterReplaceNode", "x-enum-as-string": true }, "Hostname": { "description": "Hostname of the node being replaced.", "type": "string", "x-omitempty": true }, "NodeId": { "description": "Node id of the node being replaced.", "type": "integer", "format": "int64", "x-omitempty": true }, "NodeIpChanged": { "description": "If the node being replaced has a different IP.", "type": "boolean", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.ClusterReplaceNode.List": { "title": "List of 'appliance.ClusterReplaceNode' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.ClusterReplaceNode' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.ClusterReplaceNode' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.ClusterReplaceNode" }, "nullable": true } } } ] }, "appliance.ClusterWorkerNode.Response": { "description": "The response body of a HTTP GET request for the 'appliance.ClusterWorkerNode' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.ClusterWorkerNode' resources.", "x-one-of-name": "appliance.ClusterWorkerNode.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.ClusterWorkerNode.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.ClusterWorkerNode": { "title": "Appliance:Cluster Worker Node", "description": "ClusterWorkerNode is an object that tracks the Intersight Appliance's process for adding a worker node.", "x-allOf-name": "appliance.ClusterWorkerNode", "allOf": [ { "$ref": "#/components/schemas/appliance.ClusterInstallBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ClusterWorkerNode', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ClusterWorkerNode" ], "default": "appliance.ClusterWorkerNode", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ClusterWorkerNode" ], "default": "appliance.ClusterWorkerNode", "x-enum-as-string": true }, "Hostname": { "description": "Hostname of the worker node being added.", "type": "string", "x-omitempty": true }, "ReuseNode": { "description": "Indicates if the worker node being added is being reused.", "type": "boolean", "x-omitempty": true }, "SessionId": { "description": "Session Moid for the user session.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.ClusterWorkerNode.List": { "title": "List of 'appliance.ClusterWorkerNode' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.ClusterWorkerNode' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.ClusterWorkerNode' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.ClusterWorkerNode" }, "nullable": true } } } ] }, "appliance.ClusterWorkerNodeReplace": { "title": "Appliance:Cluster Worker Node Replace", "description": "ClusterWorkerNodeReplace is an object that marks the worker node out of service for replacement.", "x-allOf-name": "appliance.ClusterWorkerNodeReplace", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ClusterWorkerNodeReplace', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ClusterWorkerNodeReplace" ], "default": "appliance.ClusterWorkerNodeReplace", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ClusterWorkerNodeReplace" ], "default": "appliance.ClusterWorkerNodeReplace", "x-enum-as-string": true }, "Hostname": { "description": "Hostname of the worker node being replaced.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.ClusterWorkerNodeReuse": { "title": "Appliance:Cluster Worker Node Reuse", "description": "The ClusterWorkerNodeReuse object facilitates the reconnection process for worker nodes within the Intersight Appliance cluster. It triggers the appliance's procedures to re-establish connectivity with worker nodes.\n#### Purpose\nClusterWorkerNodeReuse is utilized to manage the lifecycle of worker nodes in the Intersight Appliance. It supports operations to reconnect nodes, ensuring that the cluster maintains its integrity and performance.\n#### Key Concepts\n- **Reconnection Process:** Provides a structured approach to reconnecting worker nodes, essential for maintaining cluster functionality.\n- **Integration with Accounts:** Establishes relationships between node objects and accounts, ensuring that node reconnection aligns with account management.\n- **Lifecycle Management:** Supports the creation of processes necessary for reconnecting nodes, aiding in cluster maintenance and stability.", "x-allOf-name": "appliance.ClusterWorkerNodeReuse", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ClusterWorkerNodeReuse', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ClusterWorkerNodeReuse" ], "default": "appliance.ClusterWorkerNodeReuse", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ClusterWorkerNodeReuse" ], "default": "appliance.ClusterWorkerNodeReuse", "x-enum-as-string": true }, "Hostname": { "description": "Hostname of the node being reconnected.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.CpuUtilization.Response": { "description": "The response body of a HTTP GET request for the 'appliance.CpuUtilization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.CpuUtilization' resources.", "x-one-of-name": "appliance.CpuUtilization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.CpuUtilization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.CpuUtilization": { "title": "Appliance:Cpu Utilization", "description": "CPU utilization metrics for Intersight Appliance nodes. Tracks the percentage \nof CPU capacity being used, helping administrators monitor processor load and \nidentify performance bottlenecks across the cluster.", "x-allOf-name": "appliance.CpuUtilization", "allOf": [ { "$ref": "#/components/schemas/appliance.NodeUtilizationMetric" } ] }, "appliance.CpuUtilization.List": { "title": "List of 'appliance.CpuUtilization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.CpuUtilization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.CpuUtilization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.CpuUtilization" }, "nullable": true } } } ] }, "appliance.DataExportPolicy.Response": { "description": "The response body of a HTTP GET request for the 'appliance.DataExportPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.DataExportPolicy' resources.", "x-one-of-name": "appliance.DataExportPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.DataExportPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.DataExportPolicy.Relationship": { "description": "A relationship to the 'appliance.DataExportPolicy' resource, or the expanded 'appliance.DataExportPolicy' resource, or the 'null' value.", "x-one-of-name": "appliance.DataExportPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.DataExportPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.DataExportPolicy": { "title": "Appliance:Data Export Policy", "description": "DataExportPolicies define category-based data collection controls for exporting data from an Intersight Appliance to Intersight. The policy is organized as a hierarchy of categories and sub-categories (for example, Global \u2192 Inventory \u2192 Network/Storage, and TechSupport), allowing administrators to enable or disable export at different levels while preserving a clear parent/child structure.\n#### Purpose\nProvide centralized, hierarchical control over which categories of appliance data are collected and exported to Intersight, supporting governance, privacy/compliance needs, and operational control of data collection behavior.\n#### Key Concepts\n- **Hierarchical category model**: Policies form a tree of configurations where a parent category (e.g., Inventory) can contain sub-configurations (e.g., Network, Storage).\n- **Cascading enable/disable semantics**: Enabling or disabling a category implicitly enables/disables all of its sub-categories (e.g., toggling Inventory also affects Network and Storage).\n- **Primary control switch**: `enable` is the core read/write flag indicating whether data export (collection) is enabled for that category node.\n- **System-managed naming**: `name` is read-only for API consumers but system-writable (`sysapiaccess: readwrite`), indicating naming may be controlled/seeded by the appliance/system.\n- **Account-scoped governance**: Inherits permissions from `account`, and relates to `iam.Account` to scope policy ownership and access.\n- **Parent/child lifecycle handling**: `subConfigs` are children of a given category; deletion cascades to sub-configurations, preserving hierarchy consistency.\n- **Operational access control**: READ is available to admins/read roles and the \u201cConfigure Data Collection Settings\u201d privilege; UPDATE is restricted to administrators with configuration privileges.", "x-allOf-name": "appliance.DataExportPolicy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.DataExportPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.DataExportPolicy" ], "default": "appliance.DataExportPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.DataExportPolicy" ], "default": "appliance.DataExportPolicy", "x-enum-as-string": true }, "Enable": { "description": "Status of the data collection mode. If the value is 'true', then data collection is enabled.", "type": "boolean", "x-omitempty": true }, "Name": { "description": "Name of the Data Export Policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." }, "ParentConfig": { "$ref": "#/components/schemas/appliance.DataExportPolicy.Relationship", "description": "A reference to a applianceDataExportPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SubConfigs": { "description": "An array of relationships to applianceDataExportPolicy resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.DataExportPolicy.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "appliance.DataExportPolicy.List": { "title": "List of 'appliance.DataExportPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.DataExportPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.DataExportPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.DataExportPolicy" }, "nullable": true } } } ] }, "appliance.DeviceCertificate.Response": { "description": "The response body of a HTTP GET request for the 'appliance.DeviceCertificate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.DeviceCertificate' resources.", "x-one-of-name": "appliance.DeviceCertificate.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.DeviceCertificate.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.DeviceCertificate": { "title": "Appliance:Device Certificate", "description": "The DeviceCertificate object stores the CA Certificate used by the Intersight Appliance's device connector. It tracks the renewal process and ensures the certificate's integrity and validity.\n#### Purpose\nDeviceCertificate serves as a repository for CA Certificates, providing essential data for device connectors. It manages the certificate renewal process, ensuring that certificates remain valid and secure.\n#### Key Concepts\n- **Certificate Management:** Stores and manages CA Certificates, supporting secure communication.\n- **Renewal Tracking:** Monitors the certificate renewal process, ensuring timely updates and compliance.\n- **Integration with Operations:** Establishes relationships with operation configurations, aligning certificate processes with operational needs.", "x-allOf-name": "appliance.DeviceCertificate", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.DeviceCertificate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.DeviceCertificate" ], "default": "appliance.DeviceCertificate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.DeviceCertificate" ], "default": "appliance.DeviceCertificate", "x-enum-as-string": true }, "CaCertificate": { "description": "The base64 encoded certificate in PEM format.", "type": "string", "readOnly": true, "x-omitempty": true }, "CaCertificateExpiryTime": { "description": "The expiry datetime of new ca certificate which need to be applied on device connector.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "CertificateRenewalExpiryTime": { "description": "The date time allocated till cert renewal will be executed. This time used here will be based on cert\nrenewal plan.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "CompletedPhases": { "type": "array", "items": { "description": "Collection of the completed certificate renewal phases.", "$ref": "#/components/schemas/appliance.CertRenewalPhase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ConfigurationMoId": { "description": "The operation configuration MOId.", "type": "string", "x-omitempty": true }, "CurrentPhase": { "description": "Current phase of the Intersight Appliance's Certificate Renewal.", "$ref": "#/components/schemas/appliance.CertRenewalPhase", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date of the certificate renewal.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastSuccessPollTime": { "description": "The last poll time when data collection was successfull. This time is used to collect data after this time in next cycle.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Messages": { "type": "array", "items": { "description": "Messages generated during the cert renewal process.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "StartTime": { "description": "Start date of the certificate renewal.", "type": "string", "format": "date-time", "x-omitempty": true }, "Status": { "description": "The status of ca certificate renewal.", "type": "string", "x-omitempty": true } } } ] }, "appliance.DeviceCertificate.List": { "title": "List of 'appliance.DeviceCertificate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.DeviceCertificate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.DeviceCertificate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.DeviceCertificate" }, "nullable": true } } } ] }, "appliance.DeviceClaim.Response": { "description": "The response body of a HTTP GET request for the 'appliance.DeviceClaim' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.DeviceClaim' resources.", "x-one-of-name": "appliance.DeviceClaim.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.DeviceClaim.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.DeviceClaim": { "title": "Appliance:Device Claim", "description": "The DeviceClaim object represents a user-initiated claim request for endpoint devices within the Intersight Appliance. It facilitates the multi-step operation of claiming devices, integrating with workflows to process requests.\n#### Purpose\nDeviceClaim serves as a mechanism to claim endpoint devices, allowing users to register and manage devices within the Intersight Appliance ecosystem. This provides insights into the claim process, supporting device integration and management.\n#### Key Concepts\n- **Multi-step Operation:** DeviceClaim initiates workflows with multiple tasks, ensuring comprehensive processing of claim requests.\n- **User-defined Identifiers:** Supports user-defined claim request identifiers, enabling customization and tracking of claim operations.\n- **Integration with Resources:** Establishes relationships with resource reservations, integrating claimed devices into resource groups.\n- **Access Control:** Utilizes privilege sets to manage claim processes, ensuring secure and authorized operations.", "x-allOf-name": "appliance.DeviceClaim", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.DeviceClaim', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.DeviceClaim" ], "default": "appliance.DeviceClaim", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.DeviceClaim" ], "default": "appliance.DeviceClaim", "x-enum-as-string": true }, "DeviceId": { "description": "Device identifier of the endpoint device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Hostname": { "description": "Hostname or IP address of the endpoint device the user wants to claim.", "type": "string", "x-createOnly": true, "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 }, "IsRenew": { "description": "Tracks if this device is to be claimed or certificate renewal.", "type": "boolean", "default": false, "x-omitempty": true }, "Message": { "description": "Message set by the device claim process.", "type": "string", "readOnly": true, "x-omitempty": true }, "Password": { "description": "Password to be used to login to the endpoint device.", "type": "string", "writeOnly": true, "x-omitempty": true }, "PlatformType": { "description": "Platform type of the endpoint device.\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-createOnly": true, "x-omitempty": true }, "RequestId": { "description": "User defined claim request identifier set by the UI. The RequestId field is not a mandatory. The Intersight Appliance will assign a unique value automatically if the field is not set.", "type": "string", "x-omitempty": true }, "SecurityToken": { "description": "Device security token of the endpoint device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the device claim process.\n* `started` - Device claim operation has started.\n* `failed` - Device claim operation has failed.\n* `completed` - Device claim operation has completed.", "type": "string", "enum": [ "started", "failed", "completed" ], "default": "started", "readOnly": true, "x-omitempty": true }, "Username": { "description": "Username to log in to the endpoint device.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "AssignedLocation": { "$ref": "#/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.", "x-createOnly": true }, "Reservation": { "$ref": "#/components/schemas/resource.Reservation.Relationship", "description": "A reference to a resourceReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "TlsCertificate": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "appliance.DeviceClaim.List": { "title": "List of 'appliance.DeviceClaim' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.DeviceClaim' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.DeviceClaim' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.DeviceClaim" }, "nullable": true } } } ] }, "appliance.DeviceClusterInstall.Response": { "description": "The response body of a HTTP GET request for the 'appliance.DeviceClusterInstall' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.DeviceClusterInstall' resources.", "x-one-of-name": "appliance.DeviceClusterInstall.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.DeviceClusterInstall.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.DeviceClusterInstall": { "title": "Appliance:Device Cluster Install", "description": "The DeviceClusterInstall object tracks the installation process of Intersight Cluster Appliances, providing insights into system setup and configuration.\n#### Purpose\nDeviceClusterInstall monitors the various phases of cluster installation, aiding in successful deployments and system readiness.\n#### Key Concepts\n- **Phase Tracking:** Records current and completed installation phases, ensuring comprehensive monitoring and progress visibility.\n- **Node Management:** Documents node information, supporting efficient network configuration and cluster management.\n- **Error Reporting:** Captures installation errors, facilitating troubleshooting and ensuring successful setups.", "x-allOf-name": "appliance.DeviceClusterInstall", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.DeviceClusterInstall', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.DeviceClusterInstall" ], "default": "appliance.DeviceClusterInstall", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.DeviceClusterInstall" ], "default": "appliance.DeviceClusterInstall", "x-enum-as-string": true }, "CompletedPhases": { "type": "array", "items": { "description": "Collection of the completed software install phases.", "$ref": "#/components/schemas/appliance.ClusterInstallPhase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "CurrentPhase": { "description": "Current phase of the Intersight Appliance's software install.", "$ref": "#/components/schemas/appliance.ClusterInstallPhase", "readOnly": true, "x-omitempty": true }, "ElapsedTime": { "description": "Elapsed time in seconds during the software install.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date of the software install.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ErrorCode": { "description": "Error code for Intersight Appliance's software install. In case of failure - this code will help decide if software install can be retried.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Messages": { "type": "array", "items": { "description": "Messages generated during the software install process.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NodeInfo": { "type": "array", "items": { "description": "Node ip info, which contains the ip addresses and hostnames of the other cluster nodes.", "$ref": "#/components/schemas/appliance.NodeIpInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "StartTime": { "description": "Start date of the software install. UI can modify startTime to re-schedule an install.", "type": "string", "format": "date-time", "x-omitempty": true }, "Status": { "description": "Status of the Intersight Appliance's software install.\n* `NotReady` - Cluster is not ready. Install cannot be triggered.\n* `Ready` - Cluster is ready. Install can be triggered.\n* `InProgress` - Install is currently in progress.\n* `Success` - Install was run and succeeded.\n* `Fail` - Install was run and failed.", "type": "string", "enum": [ "NotReady", "Ready", "InProgress", "Success", "Fail" ], "default": "NotReady", "readOnly": true, "x-omitempty": true }, "TotalNodes": { "description": "Total number of nodes in the system.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalPhases": { "description": "TotalPhase represents the total number of the install phases for one install.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "appliance.DeviceClusterInstall.List": { "title": "List of 'appliance.DeviceClusterInstall' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.DeviceClusterInstall' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.DeviceClusterInstall' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.DeviceClusterInstall" }, "nullable": true } } } ] }, "appliance.DeviceState.Response": { "description": "The response body of a HTTP GET request for the 'appliance.DeviceState' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.DeviceState' resources.", "x-one-of-name": "appliance.DeviceState.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.DeviceState.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.DeviceState": { "title": "Appliance:Device State", "description": "The DeviceState object captures the current operational state of Intersight Appliances, providing critical data for system monitoring and management.\n#### Purpose\nDeviceState serves as a snapshot of an appliance's status, aiding in diagnostics, upgrades, and overall system health assessments.\n#### Key Concepts\n- **State Monitoring:** Records key attributes such as version, connectivity status, and upgrade capabilities, supporting informed decision-making.\n- **Cluster Information:** Provides insights into cluster configurations and node details, enhancing network management and scalability.\n- **Upgrade Facilitation:** Supports upgrade processes by tracking device state changes and readiness for updates.", "x-allOf-name": "appliance.DeviceState", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.DeviceState', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.DeviceState" ], "default": "appliance.DeviceState", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.DeviceState" ], "default": "appliance.DeviceState", "x-enum-as-string": true }, "BlockReasons": { "type": "array", "items": { "description": "Reasons why Intersight Appliance upgrade is blocked.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "BlockedVersion": { "description": "Version string of the current software bundle that is blocked for upgrade in the Intersight Appliance. It is used by UI to show banner message for blocked upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "Capabilities": { "type": "array", "items": { "description": "Capabilities represent the capabilities presented in Appliance.", "$ref": "#/components/schemas/appliance.KeyValuePair", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Certificate": { "description": "Certificate to be used for verifying software upgrade bundles. Intersight's upgrade service sets the certificate dynamically when the Intersight Appliance queries DeviceState.", "type": "string", "readOnly": true, "x-omitempty": true }, "CertificateNotAfter": { "description": "Expiration date of the software bundle verification certificate.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ClusterInfo": { "description": "Details of the Intersight Appliance cluster as reported by the Intersight Appliance's device connector.", "$ref": "#/components/schemas/onprem.ClusterInfo", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "Intersight Appliance's connectivity status. ConnectionStatus field is updated infrequently, and value may not be up to date. However, upgrade service will populate this field with actual value when queried.\n* `` - The target details have been persisted but Intersight has not yet attempted to connect to the target.\n* `Connected` - Intersight is able to establish a connection to the target and initiate management activities.\n* `NotConnected` - Intersight is unable to establish a connection to the target.\n* `ClaimInProgress` - Claim of the target is in progress. A connection to the target has not been fully established.\n* `UnclaimInProgress` - Unclaim of the target is in progress. Intersight is able to connect to the target and all management operations are supported.\n* `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. Also indicates the failure to claim Targets of type HTTP Endpoint in Intersight.\n* `Claimed` - Target of type HTTP Endpoint is successfully claimed in Intersight. Currently no validation is performed to verify the Target connectivity from Intersight at the time of creation. However invoking API from Intersight Orchestrator fails if this Target is not reachable from Intersight or if Target API credentials are incorrect.\n* `PreClaimed` - Target has been pre-claimed and is pending claim completion. Pre-claimed targets are pre-provisioned before endpoint is available to connect to Intersight, once target connects the claim can be completed by providing the security token to the pre-claim API.", "type": "string", "enum": [ "", "Connected", "NotConnected", "ClaimInProgress", "UnclaimInProgress", "Unclaimed", "Claimed", "PreClaimed" ], "default": "", "readOnly": true, "x-omitempty": true }, "CurrentFingerprint": { "description": "Fingerprint of the software bundle that is currently installed in the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "CurrentVersion": { "description": "Version string of the current software bundle that is installed in the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "DcVersion": { "description": "Version string of the Intersight Appliance's device connector. Device connector reports version number during the initial handshake.", "type": "string", "readOnly": true, "x-omitempty": true }, "DesiredVersion": { "description": "The desired software bundle version of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "DownloadedFingerprint": { "description": "Fingerprint of the downloaded software bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "DownloadedMetadataVersion": { "type": "array", "items": { "description": "The downloaded metadata version for each bucket on the Intersight Appliance.", "$ref": "#/components/schemas/appliance.MetadataManifestVersion", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DownloadedVersion": { "description": "Intersight appliance software bundle version downloaded on the endpoint.\nOnce Intersight Appliance upgrade service starts processing the version, it is updated as pending version.", "type": "string", "readOnly": true, "x-omitempty": true }, "Hostname": { "description": "Hostname of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "PendingFingerprint": { "description": "Fingerprint of the pending software bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "PendingVersion": { "description": "Version string of the pending software bundle that the Intersight Appliance will install.", "type": "string", "readOnly": true, "x-omitempty": true }, "SerialId": { "description": "SerialId of the Intersight Appliance. SerialId is generated when the Intersight Appliance is setup. SerialId is a unique UUID string, and it will not change for the life time of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpgradeBlocked": { "description": "Flag to indicate whether upgrade on this Intersight Appliance is blocked.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 }, "UpgradePolicy": { "$ref": "#/components/schemas/appliance.DeviceUpgradePolicy.Relationship", "description": "A reference to a applianceDeviceUpgradePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "appliance.DeviceState.List": { "title": "List of 'appliance.DeviceState' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.DeviceState' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.DeviceState' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.DeviceState" }, "nullable": true } } } ] }, "appliance.DeviceUpgradePolicy.Response": { "description": "The response body of a HTTP GET request for the 'appliance.DeviceUpgradePolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.DeviceUpgradePolicy' resources.", "x-one-of-name": "appliance.DeviceUpgradePolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.DeviceUpgradePolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.DeviceUpgradePolicy.Relationship": { "description": "A relationship to the 'appliance.DeviceUpgradePolicy' resource, or the expanded 'appliance.DeviceUpgradePolicy' resource, or the 'null' value.", "x-one-of-name": "appliance.DeviceUpgradePolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.DeviceUpgradePolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.DeviceUpgradePolicy": { "title": "Appliance:Device Upgrade Policy", "description": "The DeviceUpgradePolicy object defines the upgrade policies of Intersight Appliances, guiding the automated and scheduled distribution of software updates.\n#### Purpose\nDeviceUpgradePolicy establishes comprehensive rules for software upgrades, ensuring systematic and controlled deployment across appliances.\n#### Key Concepts\n- **Automation Control:** Provides settings for auto-upgrade initiation, allowing flexibility in update scheduling and execution.\n- **Metadata Synchronization:** Supports immediate or scheduled metadata file syncing, enhancing data consistency and appliance performance.\n- **Blackout Management:** Enables definition of blackout periods to prevent upgrades during specific times, maintaining operational stability.", "x-allOf-name": "appliance.DeviceUpgradePolicy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.DeviceUpgradePolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.DeviceUpgradePolicy" ], "default": "appliance.DeviceUpgradePolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.DeviceUpgradePolicy" ], "default": "appliance.DeviceUpgradePolicy", "x-enum-as-string": true }, "AutoUpgrade": { "description": "Indicates if the upgrade service is set to automatically start the software upgrade or not. If autoUpgrade is true, then the value of the schedule field is ignored.", "type": "boolean", "x-omitempty": true }, "BlackoutDatesEnabled": { "description": "If enabled, allows the user to define a blackout period during which the appliance will not be upgraded.", "type": "boolean", "x-omitempty": true }, "BlackoutEndDate": { "description": "End date of the black out period.", "type": "string", "format": "date-time", "x-omitempty": true }, "BlackoutStartDate": { "description": "Start date of the black out period. The appliance will not be upgraded during this period.", "type": "string", "format": "date-time", "x-omitempty": true }, "DisruptiveGracePeriodWeek": { "description": "Updates requiring a reboot will start automatically once the grace period ends.", "type": "integer", "format": "int64", "x-omitempty": true }, "EnableMetaDataSync": { "description": "Indicates if the updated metadata files should be synced immediately or at the next upgrade.", "type": "boolean", "default": true, "x-omitempty": true }, "IsCustomGracePeriodEnabled": { "description": "Custom grace period for subsequent reboot and non-reboot updates.", "type": "boolean", "x-omitempty": true }, "NondisruptiveGracePeriodWeek": { "description": "Updates not requiring a reboot will start automatically once the grace period ends.", "type": "integer", "format": "int64", "x-omitempty": true }, "Schedule": { "description": "User defined schedule for upgrading the Intersight Appliance software.", "$ref": "#/components/schemas/onprem.Schedule", "x-omitempty": true }, "SerialId": { "description": "SerialId of the Intersight Appliance. SerialId is generated when the Intersight Appliance is setup. It is a unique UUID string, and serialId will not change for the life time of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareDownloadType": { "description": "UpgradeType is used to indicate the kink of software upload to upgrade.\n* `unknown` - Indicates user setting of upgrade service to unknown.\n* `connected` - Indicates if the upgrade service is set to upload software to latest version automatically.\n* `manual` - Indicates if the upgrade service is set to upload software to user picked verison manually.", "type": "string", "enum": [ "unknown", "connected", "manual" ], "default": "unknown", "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "appliance.DeviceUpgradePolicy.List": { "title": "List of 'appliance.DeviceUpgradePolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.DeviceUpgradePolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.DeviceUpgradePolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.DeviceUpgradePolicy" }, "nullable": true } } } ] }, "appliance.DiagSetting.Response": { "description": "The response body of a HTTP GET request for the 'appliance.DiagSetting' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.DiagSetting' resources.", "x-one-of-name": "appliance.DiagSetting.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.DiagSetting.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.DiagSetting": { "title": "Appliance:Diag Setting", "description": "The DiagSetting object is used to manage the password of the Intersight Appliance's OS diagnostic user account. It is designed to ensure secure access to the appliance's virtual machine for diagnostic purposes.\n#### Purpose\nDiagSetting provides administrators with the ability to change the password of the diagnostic user account, facilitating secure management of the Intersight Appliance's diagnostics. It ensures that only authorized users can access diagnostic features.\n#### Key Concepts\n- **Password Management:** Allows administrators to update the diagnostic user account password, enhancing security.\n- **Access Control:** Restricted to account administrators, ensuring that sensitive operations are conducted securely.\n- **Diagnostic Access:** Supports secure login to the Intersight Appliance virtual machine for diagnostic purposes.", "x-allOf-name": "appliance.DiagSetting", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.DiagSetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.DiagSetting" ], "default": "appliance.DiagSetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.DiagSetting" ], "default": "appliance.DiagSetting", "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 }, "Message": { "description": "Status message of the password change operation.", "type": "string", "x-omitempty": true }, "Password": { "description": "Password of the Intersight Appliance's OS diagnostic user account.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.DiagSetting.List": { "title": "List of 'appliance.DiagSetting' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.DiagSetting' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.DiagSetting' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.DiagSetting" }, "nullable": true } } } ] }, "appliance.ExternalSyslogSetting.Response": { "description": "The response body of a HTTP GET request for the 'appliance.ExternalSyslogSetting' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.ExternalSyslogSetting' resources.", "x-one-of-name": "appliance.ExternalSyslogSetting.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.ExternalSyslogSetting.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.ExternalSyslogSetting": { "title": "Appliance:External Syslog Setting", "description": "The ExternalSyslogSetting object configures the external Syslog server for the Intersight Appliance. It allows administrators to define how Syslog messages are transmitted to external servers.\n#### Purpose\nExternalSyslogSetting provides a mechanism to manage Syslog server configurations, facilitating the transmission of logs to external systems for monitoring and analysis. It supports various protocols and configurations to adapt to different network environments.\n#### Key Concepts\n- **Syslog Configuration:** Enables configuration of external Syslog servers, including server addresses and ports.\n- **Protocol Management:** Supports multiple communication protocols, providing flexibility in Syslog message transmission.\n- **Access Control:** Restricted to authorized users, ensuring secure configuration of Syslog settings.\n- **Log Exporting:** Facilitates the export of various logs, including audit and alarm logs, to external servers.", "x-allOf-name": "appliance.ExternalSyslogSetting", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ExternalSyslogSetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ExternalSyslogSetting" ], "default": "appliance.ExternalSyslogSetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ExternalSyslogSetting" ], "default": "appliance.ExternalSyslogSetting", "x-enum-as-string": true }, "Enabled": { "description": "Enable or disable External Syslog Server.", "type": "boolean", "default": false, "x-omitempty": true }, "ExportAlarms": { "description": "If the flag is set, the alarms reported in Intersight Appliances are exported to external syslog server based on the alarm severity selection.", "type": "boolean", "default": false, "x-omitempty": true }, "ExportAudit": { "description": "Enable or disable exporting of Audit logs.", "type": "boolean", "default": false, "x-omitempty": true }, "ExportNginx": { "description": "Enable or disable exporting of Web Server access logs.", "type": "boolean", "default": false, "x-omitempty": true }, "Port": { "description": "External Syslog Server Port for connection establishment.", "type": "integer", "format": "int64", "default": 10514, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "Protocol": { "description": "Protocol used to connect to external syslog server.\n* `TCP` - External Syslog messages sent over TCP.\n* `UDP` - External Syslog messages sent over UDP.\n* `TLS` - Secure External Syslog messages sent over TLS.", "type": "string", "enum": [ "TCP", "UDP", "TLS" ], "default": "TCP", "x-omitempty": true }, "Server": { "description": "External Syslog Server Address, can be IP address or hostname.", "type": "string", "x-omitempty": true }, "Severity": { "description": "Minimum severity level to report.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.ExternalSyslogSetting.List": { "title": "List of 'appliance.ExternalSyslogSetting' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.ExternalSyslogSetting' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.ExternalSyslogSetting' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.ExternalSyslogSetting" }, "nullable": true } } } ] }, "appliance.FileGateway.Response": { "description": "The response body of a HTTP GET request for the 'appliance.FileGateway' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.FileGateway' resources.", "x-one-of-name": "appliance.FileGateway.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.FileGateway.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.FileGateway": { "title": "Appliance:File Gateway", "description": "The FileGateway object provides non-persistent access to files from the Intersight, facilitating efficient file retrieval and storage.\n#### Purpose\nFileGateway acts as a proxy for accessing files stored in the cloud, ensuring reliable and timely data access for Intersight Appliances.\n#### Key Concepts\n- **URL Provisioning:** Supplies pre-signed URLs for file downloads, streamlining data transfer processes and reducing latency.\n- **Access Transparency:** Does not store access records, simplifying file retrieval and enhancing privacy.\n- **Integration:** Enables seamless file access through signed URLs, supporting efficient data handling and storage management.", "x-allOf-name": "appliance.FileGateway", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.FileGateway', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.FileGateway" ], "default": "appliance.FileGateway", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.FileGateway" ], "default": "appliance.FileGateway", "x-enum-as-string": true }, "BucketName": { "description": "Bucket name in the cloud storage service where the file is stored.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalHost": { "description": "Flag to specify if the requested file is served from an external host. An external host is a host other than the Intersight endpoint URL that resides outside of an endpoint device's local network. A download client (e.g. the Intersight Appliance device connector) should use this property to determine if a proxy is required to reach the host.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "FileSize": { "description": "Size of the file in bytes. FileSize maybe zero if the storage service does not report file size.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FileTime": { "description": "File timestamp as reported by the cloud storage service.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "FileType": { "description": "User defined file type supplied by the caller.", "type": "string", "readOnly": true, "x-omitempty": true }, "Filename": { "description": "Full name of the file as it exists in the cloud storage service. If the file is in a subfolder, then the filename must contain the full path.", "type": "string", "readOnly": true, "x-omitempty": true }, "PresignedUrl": { "description": "Pre-signed URL obtained from the cloud storage service.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerCert": { "description": "SSL certificate of the cloud storage service.", "type": "string", "readOnly": true, "x-omitempty": true }, "ValidityPeriod": { "description": "Signed URL's validity period in minutes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Version": { "description": "File version as reported by the cloud storage service.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.FileGateway.List": { "title": "List of 'appliance.FileGateway' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.FileGateway' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.FileGateway' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.FileGateway" }, "nullable": true } } } ] }, "appliance.FileSystemOpStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.FileSystemOpStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.FileSystemOpStatus' resources.", "x-one-of-name": "appliance.FileSystemOpStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.FileSystemOpStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.FileSystemOpStatus.Relationship": { "description": "A relationship to the 'appliance.FileSystemOpStatus' resource, or the expanded 'appliance.FileSystemOpStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.FileSystemOpStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.FileSystemOpStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.FileSystemOpStatus": { "title": "Appliance:File System Op Status", "description": "The FileSystemOpStatus object denotes the operational status of file systems within an Intersight Appliance node. It highlights the capacity and usage metrics critical to maintaining system efficiency.\n#### Purpose\nFileSystemOpStatus ensures the health and functionality of file systems, presenting data on usage and capacity that supports system reliability and performance.\n#### Key Concepts\n- **File System Health:** Determines the operational status through checks that categorize the state as Operational, AttentionNeeded, or Impaired.\n- **Capacity Management:** Provides insights into file system capacity and usage to prevent overutilization and maintain optimal performance.\n- **System Linkages:** Connects with device registration to integrate file system status within broader system health metrics.", "x-allOf-name": "appliance.FileSystemOpStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.FileSystemOpStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.FileSystemOpStatus" ], "default": "appliance.FileSystemOpStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.FileSystemOpStatus" ], "default": "appliance.FileSystemOpStatus", "x-enum-as-string": true }, "Capacity": { "description": "Capacity of the file system in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DiskOrder": { "description": "Symbolic order identifier of the physical disk from /dev/disk/by-order (e.g., disk1, disk2).\nThis provides a stable, human-readable identifier for the disk that persists across reboots,\nunlike device names which may change. Currently, the relationship between filesystems to disks\nis one-to-one and this is unlikely to change in the future.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mountpoint": { "description": "Mount point of this file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeHostname": { "description": "Hostname of the Intersight Appliance node on which this filesystem is located.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the file system.\nOperational status is based on the result of the status\nchecks. If result of any check is Critical, then its\nvalue is Impaired. Otherwise, if result of any check is\nWarning, then its value is AttentionNeeded. If all\nchecks are OK, then its value is Operational.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Usage": { "description": "Percentage of the file system capacity currently in use.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "FileSystemOpSummary": { "$ref": "#/components/schemas/appliance.FileSystemOpSummary.Relationship", "description": "A reference to a applianceFileSystemOpSummary resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NodeOpStatus": { "$ref": "#/components/schemas/appliance.NodeOpStatus.Relationship", "description": "A reference to a applianceNodeOpStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "appliance.FileSystemOpStatus.List": { "title": "List of 'appliance.FileSystemOpStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.FileSystemOpStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.FileSystemOpStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.FileSystemOpStatus" }, "nullable": true } } } ] }, "appliance.FileSystemOpSummary.Response": { "description": "The response body of a HTTP GET request for the 'appliance.FileSystemOpSummary' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.FileSystemOpSummary' resources.", "x-one-of-name": "appliance.FileSystemOpSummary.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.FileSystemOpSummary.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.FileSystemOpSummary.Relationship": { "description": "A relationship to the 'appliance.FileSystemOpSummary' resource, or the expanded 'appliance.FileSystemOpSummary' resource, or the 'null' value.", "x-one-of-name": "appliance.FileSystemOpSummary.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.FileSystemOpSummary" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.FileSystemOpSummary": { "title": "Appliance:File System Op Summary", "description": "The FileSystemOpSummary object aggregates alarm summaries for file systems on an Intersight Appliance node. It serves as an essential tool for maintaining system efficiency and reliability by summarizing critical health and capacity metrics.\n#### Purpose\nFileSystemOpSummary provides a consolidated view of file system health, supporting capacity management and ensuring that file systems remain operational and efficient. It highlights alarm counts per severity, aiding in proactive system management.\n#### Key Concepts\n- **Alarm Aggregation** Consolidates alarm data to provide a health score, facilitating quick identification of critical issues.\n- **Capacity Insights** Offers detailed views into file system usage and capacity, preventing overutilization and ensuring optimal performance.\n- **System Integration** Links file system status with broader system health metrics, contributing to comprehensive system management.", "x-allOf-name": "appliance.FileSystemOpSummary", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.FileSystemOpSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.FileSystemOpSummary" ], "default": "appliance.FileSystemOpSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.FileSystemOpSummary" ], "default": "appliance.FileSystemOpSummary", "x-enum-as-string": true }, "AlarmSummary": { "description": "AlarmSummary is a health score calculation and aggregation of alarm counts per severity of alarms.", "$ref": "#/components/schemas/cond.AlarmSummary", "readOnly": true, "x-omitempty": true }, "NodeOpStatus": { "$ref": "#/components/schemas/appliance.NodeOpStatus.Relationship", "description": "A reference to a applianceNodeOpStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.FileSystemOpSummary.List": { "title": "List of 'appliance.FileSystemOpSummary' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.FileSystemOpSummary' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.FileSystemOpSummary' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.FileSystemOpSummary" }, "nullable": true } } } ] }, "appliance.FileSystemStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.FileSystemStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.FileSystemStatus' resources.", "x-one-of-name": "appliance.FileSystemStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.FileSystemStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.FileSystemStatus.Relationship": { "description": "A relationship to the 'appliance.FileSystemStatus' resource, or the expanded 'appliance.FileSystemStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.FileSystemStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.FileSystemStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.FileSystemStatus": { "title": "Appliance:File System Status", "description": "Status of a file system on an Intersight Appliance node.", "x-allOf-name": "appliance.FileSystemStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.FileSystemStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.FileSystemStatus" ], "default": "appliance.FileSystemStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.FileSystemStatus" ], "default": "appliance.FileSystemStatus", "x-enum-as-string": true }, "Capacity": { "description": "Capacity of the file system in bytes.", "type": "integer", "format": "int64", "x-omitempty": true }, "Mountpoint": { "description": "Mount point of this file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the file system.\nOperational status is based on the result of the status\nchecks. If result of any check is Critical, then its\nvalue is Impaired. Otherwise, if result of any check is\nWarning, then its value is AttentionNeeded. If all\nchecks are OK, then its value is Operational.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "StatusChecks": { "type": "array", "items": { "description": "A collection of the status checks performed.", "$ref": "#/components/schemas/appliance.StatusCheck", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Usage": { "description": "Percentage of the file system capacity currently in use.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "NodeStatus": { "$ref": "#/components/schemas/appliance.NodeStatus.Relationship", "description": "A reference to a applianceNodeStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.FileSystemStatus.List": { "title": "List of 'appliance.FileSystemStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.FileSystemStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.FileSystemStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.FileSystemStatus" }, "nullable": true } } } ] }, "appliance.FileSystemTelemetry.Response": { "description": "The response body of a HTTP GET request for the 'appliance.FileSystemTelemetry' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.FileSystemTelemetry' resources.", "x-one-of-name": "appliance.FileSystemTelemetry.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.FileSystemTelemetry.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.FileSystemTelemetry": { "title": "Appliance:File System Telemetry", "description": "Calculated operational status of a file system on a node.", "x-allOf-name": "appliance.FileSystemTelemetry", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.FileSystemTelemetry', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.FileSystemTelemetry" ], "default": "appliance.FileSystemTelemetry", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.FileSystemTelemetry" ], "default": "appliance.FileSystemTelemetry", "x-enum-as-string": true }, "DiskOrder": { "description": "Symbolic order identifier of the physical disk from /dev/disk/by-order (e.g., disk1, disk2).\nThis provides a stable, human-readable identifier for the disk that persists across reboots,\nunlike device names which may change. Currently, the relationship between filesystems to disks\nis one-to-one and this is unlikely to change in the future.", "type": "string", "readOnly": true, "x-omitempty": true }, "Instance": { "description": "The instance identifier from which the metrics were collected.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mountpoint": { "description": "Mount point of this file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Usage": { "description": "Operational status of filesystem utilization.\nValues are Optimal, Warning, or Critical based on configured thresholds.\n* `Optimal` - Resource usage is within normal operating parameters.\n* `Warning` - Resource usage has exceeded warning thresholds and attention may be needed.\n* `Critical` - Resource usage has exceeded critical thresholds and immediate attention is required.", "type": "string", "enum": [ "Optimal", "Warning", "Critical" ], "default": "Optimal", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "appliance.FileSystemTelemetry.List": { "title": "List of 'appliance.FileSystemTelemetry' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.FileSystemTelemetry' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.FileSystemTelemetry' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.FileSystemTelemetry" }, "nullable": true } } } ] }, "appliance.FqdnUpdate.Response": { "description": "The response body of a HTTP GET request for the 'appliance.FqdnUpdate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.FqdnUpdate' resources.", "x-one-of-name": "appliance.FqdnUpdate.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.FqdnUpdate.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.FqdnUpdate": { "title": "Appliance:Fqdn Update", "description": "FqdnUpdate provides configuration parameters for updating Appliance FQDN (fully qualified domain name) on claimed Endpoints. Appliance with new FQDN should be restored using the backup. The FQDN must be unique within the network. For multinode the input FQDN should be only one management node FQDN not the metrics node FQDN. If the restored appliance is going to be a HA cluster, other management node FQDNs will be updated during add node and cluster expansion operations.", "x-allOf-name": "appliance.FqdnUpdate", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.FqdnUpdate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.FqdnUpdate" ], "default": "appliance.FqdnUpdate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.FqdnUpdate" ], "default": "appliance.FqdnUpdate", "x-enum-as-string": true }, "EndTime": { "description": "End date of the appliance FQDN change.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Fqdn": { "description": "The FQDN (fully qualified domain name) of the destination appliance for target migration.", "type": "string", "x-omitempty": true }, "StartTime": { "description": "Start date of the appliance FQDN change.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the FQDN update operation.\n* `NotStarted` - Appliance FQDN update operation has not started.\n* `Started` - Appliance FQDN update operation has started.\n* `Failed` - Appliance FQDN update operation has failed.\n* `Completed` - Appliance FQDN update operation has completed.", "type": "string", "enum": [ "NotStarted", "Started", "Failed", "Completed" ], "default": "NotStarted", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.FqdnUpdate.List": { "title": "List of 'appliance.FqdnUpdate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.FqdnUpdate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.FqdnUpdate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.FqdnUpdate" }, "nullable": true } } } ] }, "appliance.GroupOpStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.GroupOpStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.GroupOpStatus' resources.", "x-one-of-name": "appliance.GroupOpStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.GroupOpStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.GroupOpStatus.Relationship": { "description": "A relationship to the 'appliance.GroupOpStatus' resource, or the expanded 'appliance.GroupOpStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.GroupOpStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.GroupOpStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.GroupOpStatus": { "title": "Appliance:Group Op Status", "description": "The GroupOpStatus object describes the status of a group of applications within the Intersight Appliance system. It consolidates application-specific status to provide a unified view of group health.\n#### Purpose\nGroupOpStatus aggregates application status information to offer insights into the collective health and functionality of system features, aiding in efficient management and troubleshooting.\n#### Key Concepts\n- **Group Health:** Represents the overall status of applications grouped by features like Identity Management and Core Service.\n- **Application Aggregation:** Collates individual application statuses, providing a consolidated view for easier monitoring and intervention.\n- **Operational Insights:** Offers descriptions and status indicators vital for maintaining system operations and performance.", "x-allOf-name": "appliance.GroupOpStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.GroupOpStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.GroupOpStatus" ], "default": "appliance.GroupOpStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.GroupOpStatus" ], "default": "appliance.GroupOpStatus", "x-enum-as-string": true }, "Description": { "description": "Description of the group.", "type": "string", "readOnly": true, "x-omitempty": true }, "GroupName": { "description": "The name of group, which includes Identity Management, Device Connector Service, Core Service, Analytics, Infra and Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "OverallStatus": { "description": "The overall API status from this group's applications.", "type": "string", "readOnly": true, "x-omitempty": true }, "Apps": { "description": "An array of relationships to applianceAppOpStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.AppOpStatus.Relationship" }, "nullable": true, "readOnly": true }, "SystemOpStatus": { "$ref": "#/components/schemas/appliance.SystemOpStatus.Relationship", "description": "A reference to a applianceSystemOpStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.GroupOpStatus.List": { "title": "List of 'appliance.GroupOpStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.GroupOpStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.GroupOpStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.GroupOpStatus" }, "nullable": true } } } ] }, "appliance.GroupStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.GroupStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.GroupStatus' resources.", "x-one-of-name": "appliance.GroupStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.GroupStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.GroupStatus.Relationship": { "description": "A relationship to the 'appliance.GroupStatus' resource, or the expanded 'appliance.GroupStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.GroupStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.GroupStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.GroupStatus": { "title": "Appliance:Group Status", "description": "Status of a group of applications.", "x-allOf-name": "appliance.GroupStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.GroupStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.GroupStatus" ], "default": "appliance.GroupStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.GroupStatus" ], "default": "appliance.GroupStatus", "x-enum-as-string": true }, "Description": { "description": "Description of the group.", "type": "string", "readOnly": true, "x-omitempty": true }, "GroupName": { "description": "The name of group, which includes Identity Management, Device Connector Service, Core Service, Analytics, Internal and Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "OverallStatus": { "description": "The overall API status from this group's applications.", "type": "string", "readOnly": true, "x-omitempty": true }, "Apps": { "description": "An array of relationships to applianceAppStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.AppStatus.Relationship" }, "nullable": true, "readOnly": true }, "SystemStatus": { "$ref": "#/components/schemas/appliance.SystemStatus.Relationship", "description": "A reference to a applianceSystemStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.GroupStatus.List": { "title": "List of 'appliance.GroupStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.GroupStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.GroupStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.GroupStatus" }, "nullable": true } } } ] }, "appliance.ImageBundle.Response": { "description": "The response body of a HTTP GET request for the 'appliance.ImageBundle' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.ImageBundle' resources.", "x-one-of-name": "appliance.ImageBundle.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.ImageBundle.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.ImageBundle.Relationship": { "description": "A relationship to the 'appliance.ImageBundle' resource, or the expanded 'appliance.ImageBundle' resource, or the 'null' value.", "x-one-of-name": "appliance.ImageBundle.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.ImageBundle" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.ImageBundle": { "title": "Appliance:Image Bundle", "description": "The ImageBundle object plays a pivotal role in managing software bundles within the Intersight Appliance. It keeps track of all installed software bundles, derived from upgrade manifests, and includes dynamic properties computed during manifest processing.\n#### Purpose\nImageBundle objects are essential for maintaining software consistency and integrity within the appliance. They manage the lifecycle of software bundles, from pending upgrades to successful installations. >\n#### Key Concepts\n- **Manifest Derivation:** Created from software upgrade manifests, incorporating additional computed properties for enhanced tracking and verification.\n- **Lifecycle Management:** Oversees the transition from pending to current bundles, ensuring software updates are applied correctly.\n- **Impact Assessment:** Utilizes UpgradeImpactEnum to evaluate the potential disruption of services during upgrades, providing foresight into upgrade effects.\n- **Dependency Handling:** Tracks dependencies between bundles, ensuring all necessary components are available for successful upgrades.", "x-allOf-name": "appliance.ImageBundle", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ImageBundle', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ImageBundle" ], "default": "appliance.ImageBundle", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ImageBundle" ], "default": "appliance.ImageBundle", "x-enum-as-string": true }, "AnsiblePackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's system installation packages.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AutoUpgrade": { "description": "Indicates that the software upgrade was automatically initiated by the Intersight Appliance.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "DcPackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's device connector packages.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DebugPackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's developer debug packages. Optional, and not installed by default.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Description": { "description": "Short description of the software upgrade bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndpointPackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's endpoint UI packages such as Cisco UCSM, Cisco HyperFlex etc.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Fingerprint": { "description": "Fingerprint of the software manifest from which this bundle is created. Fingerprint is calculated using the SHA256 algorithm.", "type": "string", "readOnly": true, "x-omitempty": true }, "HasError": { "description": "Indicates that the ImageBundle has errors. The upgrade service sets this field when it encounters errors during the manifest processing.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "InfraPackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's infrastructure service packages such as database.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "InitPackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's initialization service packages.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "Name of the software upgrade bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "Notes": { "description": "Detailed description of the software upgrade bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "Priority": { "description": "Software upgrade manifest's upgrade priority. The upgrade service supports two priorities, Normal and Critical. Normal priority is used for regular software upgrades, and the upgrade service uses the Upgrade Policy to compute upgrade start time. Critical priority is used for the critical software security patches, and the upgrade service ignores the Upgrade Policy when it computes the upgrade start time.\n* `Normal` - Normal upgrade priority is used for all the software upgrades except for the critical security updates. The upgrade service of Intersight Appliance uses the Software Upgrade Policy settings to start the upgrade process.\n* `Critical` - Critical upgrade priority is used for critical updates such as security patches. The upgrade service of the Intersight Appliance starts the upgrade as specified by the upgrade properties in the software manifest file. The upgrade service will not use the settings specified in the Software Upgrade Policy.", "type": "string", "enum": [ "Normal", "Critical" ], "default": "Normal", "readOnly": true, "x-omitempty": true }, "ReleaseTime": { "description": "Software upgrade manifest's release date and time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ServicePackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's micro-services pakages.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "StatusMessage": { "description": "Status message set during the manifest processing.", "type": "string", "readOnly": true, "x-omitempty": true }, "SystemPackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's system packages such as DNS etc.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UiPackages": { "type": "array", "items": { "description": "Collection of the Intersight Appliance's UI packages of the micro-services.", "$ref": "#/components/schemas/onprem.ImagePackage", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UpgradeEndTime": { "description": "End date of the software upgrade process.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "UpgradeGracePeriod": { "description": "Grace period in seconds before the automatic upgrade is initiated. The upgrade service uses the grace period to compute the upgrade start time when it receives an upgrade notfication from the Intersight. If there is an Upgrade Policy configured for the Intersight Appliance, then the upgrade service uses the policy to compute the upgrade start time. However, the upgrade start time cannot not exceed the limit enforced by the grace period.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UpgradeImpactDuration": { "description": "Duration (in minutes) for which services will be disrupted.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "UpgradeImpactEnum": { "description": "UpgradeImpactEnum is used to indicate the kind of impact the upgrade has on currently running services on the appliance.\n* `None` - The upgrade has no effect on the system.\n* `Disruptive` - The services will not be functional during the upgrade.\n* `Disruptive-reboot` - The upgrade needs a reboot.", "type": "string", "enum": [ "None", "Disruptive", "Disruptive-reboot" ], "default": "None", "readOnly": true, "x-omitempty": true }, "UpgradeStartTime": { "description": "Start date of the software upgrade process.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Software upgrade manifest's version.", "type": "string", "readOnly": true, "x-omitempty": true }, "Requires": { "$ref": "#/components/schemas/appliance.ImageBundle.Relationship", "description": "A reference to a applianceImageBundle resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.ImageBundle.List": { "title": "List of 'appliance.ImageBundle' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.ImageBundle' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.ImageBundle' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.ImageBundle" }, "nullable": true } } } ] }, "appliance.KeyValuePair": { "title": "Appliance:Key Value Pair", "description": "An arbitrary key and value pair that can be used to for having pair of key and values in application such as Appliance Capabilities.", "x-allOf-name": "appliance.KeyValuePair", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.KeyValuePair', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.KeyValuePair" ], "default": "appliance.KeyValuePair", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.KeyValuePair" ], "default": "appliance.KeyValuePair", "x-enum-as-string": true }, "Key": { "description": "The string representation of a tag key.", "type": "string", "minLength": 1, "maxLength": 128, "readOnly": true, "x-omitempty": true }, "Value": { "description": "The string representation of a tag value.", "type": "string", "minLength": 0, "maxLength": 256, "readOnly": true, "x-omitempty": true } } } ] }, "appliance.MemoryUtilization.Response": { "description": "The response body of a HTTP GET request for the 'appliance.MemoryUtilization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.MemoryUtilization' resources.", "x-one-of-name": "appliance.MemoryUtilization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.MemoryUtilization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.MemoryUtilization": { "title": "Appliance:Memory Utilization", "description": "Memory utilization metrics for Intersight Appliance nodes. Measures the percentage \nof physical RAM being consumed, enabling monitoring of memory pressure and capacity \nplanning for optimal cluster performance.", "x-allOf-name": "appliance.MemoryUtilization", "allOf": [ { "$ref": "#/components/schemas/appliance.NodeUtilizationMetric" } ] }, "appliance.MemoryUtilization.List": { "title": "List of 'appliance.MemoryUtilization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.MemoryUtilization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.MemoryUtilization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.MemoryUtilization" }, "nullable": true } } } ] }, "appliance.MetaManifest.Response": { "description": "The response body of a HTTP GET request for the 'appliance.MetaManifest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.MetaManifest' resources.", "x-one-of-name": "appliance.MetaManifest.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.MetaManifest.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.MetaManifest": { "title": "Appliance:Meta Manifest", "description": "MetaManifest managed object describes the files by downloading from the S3 and without having required\nuser to run the upgrade for the appliance. This MO will be polled periodically from UI to display the\ninstallation of the current and past history of Metada Manifest ImageBundle.", "x-allOf-name": "appliance.MetaManifest", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.MetaManifest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.MetaManifest" ], "default": "appliance.MetaManifest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.MetaManifest" ], "default": "appliance.MetaManifest", "x-enum-as-string": true }, "CreationDate": { "description": "Record creation date for explicitly tracking all collections for purging the old records.", "type": "string", "format": "time", "readOnly": true, "x-omitempty": true }, "FileDescription": { "description": "Metadata Manifest ImageBundle file description.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileName": { "description": "File names of the Metadata Manifest ImageBundle as reported by the pvapp portal.", "type": "string", "readOnly": true, "x-omitempty": true }, "FilechkSum": { "description": "The md5 checksum of the Metadata Manifest ImageBundle file.", "type": "string", "readOnly": true, "x-omitempty": true }, "InstallDate": { "description": "Install date of the Metadata Manifest ImageBundle.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status reported for the successful installation of the meta data files.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.MetaManifest.List": { "title": "List of 'appliance.MetaManifest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.MetaManifest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.MetaManifest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.MetaManifest" }, "nullable": true } } } ] }, "appliance.MetadataManifestVersion": { "title": "Appliance:Metadata Manifest Version", "description": "BucketVersion is a 3 tuple (bucketName, timestamp of when the metamanifest was touched, checksum).\nUniquely identifies a single metadata update to a bucket.", "x-allOf-name": "appliance.MetadataManifestVersion", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.MetadataManifestVersion', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.MetadataManifestVersion" ], "default": "appliance.MetadataManifestVersion", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.MetadataManifestVersion" ], "default": "appliance.MetadataManifestVersion", "x-enum-as-string": true }, "FileSha": { "description": "Metamanifest file checksum.", "type": "string", "x-omitempty": true }, "FileTime": { "description": "The timestamp when the metamanifest was touched.", "type": "string", "format": "date-time", "x-omitempty": true }, "MetadataType": { "description": "Name of the bucket that is being monitored.\n* `hcl-meta` - Hcl bucket, metadata update will be automatically enabled.\n* `advisories` - Advisory bucket, metadata update will be automatically enabled.\n* `onprem-images` - Onprem images bucket, metadata update will be automatically enableds.", "type": "string", "enum": [ "hcl-meta", "advisories", "onprem-images" ], "default": "hcl-meta", "x-omitempty": true } } } ] }, "appliance.MetricBase": { "title": "Appliance:Metric Base", "description": "A metric that reports a value or set of values over a measurement period.", "x-allOf-name": "appliance.MetricBase", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.MetricBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "appliance.CpuUtilization", "appliance.MemoryUtilization", "appliance.MetricsIngestionUtilization", "appliance.NodeIopsMetric" ], "x-enum-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": [ "appliance.CpuUtilization", "appliance.MemoryUtilization", "appliance.MetricsIngestionUtilization", "appliance.NodeIopsMetric" ], "x-enum-as-string": true }, "Attributes": { "description": "The set of attributes that describe that uniquely describe the metric.", "$ref": "#/components/schemas/mo.BaseComplexType", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "The end of the measurement window.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "MetaField": { "description": "Uniquely identifies the source of the metric.", "type": "string", "readOnly": true, "x-omitempty": true }, "Time": { "description": "The start of the measurement window.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.MetricsConfig.Response": { "description": "The response body of a HTTP GET request for the 'appliance.MetricsConfig' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.MetricsConfig' resources.", "x-one-of-name": "appliance.MetricsConfig.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.MetricsConfig.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.MetricsConfig": { "title": "Appliance:Metrics Config", "description": "The MetricsConfig object provides configuration parameters for managing metrics collection on the Intersight Appliance. It supports system and user-defined metrics collection settings.\n#### Purpose\nMetricsConfig serves as a framework for configuring metrics collection, enabling administrators to manage data collection based on resource constraints. This provides insights into metrics usage and supports system monitoring.\n#### Key Concepts\n- **Metrics Management:** Configures metrics collection settings, supporting efficient data management.\n- **Resource Constraints:** Monitors metrics usage based on system resources, aiding in capacity planning.\n- **Access Control:** Restricted to authorized users, ensuring secure configuration of metrics settings.\n- **Usage Tracking:** Provides detailed insights into endpoint usage, supporting informed decision-making.", "x-allOf-name": "appliance.MetricsConfig", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.MetricsConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.MetricsConfig" ], "default": "appliance.MetricsConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.MetricsConfig" ], "default": "appliance.MetricsConfig", "x-enum-as-string": true }, "CurrentEndpointCount": { "description": "Number of discovered endpoints from where metrics is being collected currently.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "DiskCapacity": { "description": "Capacity of the metrics disk /opt/database in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DiskUsage": { "description": "Disk usage of the metrics disk /opt/database in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndpointUsagePercent": { "description": "Usage percentage of the discovered endpoints.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "LastDisabledDate": { "description": "Disabled date of the metrics collection feature.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastEnabledDate": { "description": "Enabled date of the metrics collection feature.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "MaxEndpointCount": { "description": "The maximum number of supported endpoints for an appliance deployment type.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "StatusMessage": { "description": "The overall metrics collection Status based on resource constraints.", "type": "string", "readOnly": true, "x-omitempty": true }, "SystemEnabled": { "description": "Metric collection state defined by the system.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "UserEnabled": { "description": "Configured metric collection state by the account administrator.", "type": "boolean", "default": false, "x-omitempty": true }, "Utilization": { "description": "Measures the utilization of the metrics feature in relation to the available capacity of the system.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.MetricsConfig.List": { "title": "List of 'appliance.MetricsConfig' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.MetricsConfig' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.MetricsConfig' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.MetricsConfig" }, "nullable": true } } } ] }, "appliance.MetricsIngestionUtilization.Response": { "description": "The response body of a HTTP GET request for the 'appliance.MetricsIngestionUtilization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.MetricsIngestionUtilization' resources.", "x-one-of-name": "appliance.MetricsIngestionUtilization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.MetricsIngestionUtilization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.MetricsIngestionUtilization": { "title": "Appliance:Metrics Ingestion Utilization", "description": "Measures the utilization of the metrics feature in relation to the available capacity of the system.", "x-allOf-name": "appliance.MetricsIngestionUtilization", "allOf": [ { "$ref": "#/components/schemas/appliance.UtilizationMetric" } ] }, "appliance.MetricsIngestionUtilization.List": { "title": "List of 'appliance.MetricsIngestionUtilization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.MetricsIngestionUtilization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.MetricsIngestionUtilization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.MetricsIngestionUtilization" }, "nullable": true } } } ] }, "appliance.NetworkLinkStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.NetworkLinkStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.NetworkLinkStatus' resources.", "x-one-of-name": "appliance.NetworkLinkStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.NetworkLinkStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.NetworkLinkStatus.Relationship": { "description": "A relationship to the 'appliance.NetworkLinkStatus' resource, or the expanded 'appliance.NetworkLinkStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.NetworkLinkStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.NetworkLinkStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.NetworkLinkStatus": { "title": "Appliance:Network Link Status", "description": "The NetworkLinkStatus object examines the network connection between nodes in an Intersight Appliance cluster. It is vital for ensuring seamless communication and data transfer.\n#### Purpose\nNetworkLinkStatus provides insights into the connectivity and network performance between cluster nodes, facilitating efficient data flow and system integration.\n#### Key Concepts\n- **Link Health:** Assesses the network link status, reporting on connectivity and ping times between nodes.\n- **Communication Efficiency:** Ensures robust and efficient data exchange, crucial for maintaining overall system functionality.\n- **System Integration:** Integrates network link status within broader system monitoring to ensure comprehensive oversight.", "x-allOf-name": "appliance.NetworkLinkStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NetworkLinkStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.NetworkLinkStatus" ], "default": "appliance.NetworkLinkStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.NetworkLinkStatus" ], "default": "appliance.NetworkLinkStatus", "x-enum-as-string": true }, "DestinationHostname": { "description": "Hostname of the destination endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "PingTime": { "description": "Time to reach the destination endpoint in milliseconds from the source endpoint.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "SourceHostname": { "description": "Hostname of the source endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeOpStatus": { "$ref": "#/components/schemas/appliance.NodeOpStatus.Relationship", "description": "A reference to a applianceNodeOpStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "appliance.NetworkLinkStatus.List": { "title": "List of 'appliance.NetworkLinkStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.NetworkLinkStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.NetworkLinkStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.NetworkLinkStatus" }, "nullable": true } } } ] }, "appliance.NetworkStatus": { "title": "Appliance:Network Status", "description": "Time to ping a target endpoint.", "x-allOf-name": "appliance.NetworkStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NetworkStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.NetworkStatus" ], "default": "appliance.NetworkStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.NetworkStatus" ], "default": "appliance.NetworkStatus", "x-enum-as-string": true }, "DestinationHostname": { "description": "Hostname of the destination endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "PingTime": { "description": "Time to reach the destination endpoint in milliseconds from the source endpoint.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "SourceHostname": { "description": "Hostname of the source endpoint.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.NodeInfo.Response": { "description": "The response body of a HTTP GET request for the 'appliance.NodeInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.NodeInfo' resources.", "x-one-of-name": "appliance.NodeInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.NodeInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.NodeInfo.Relationship": { "description": "A relationship to the 'appliance.NodeInfo' resource, or the expanded 'appliance.NodeInfo' resource, or the 'null' value.", "x-one-of-name": "appliance.NodeInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.NodeInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.NodeInfo": { "title": "Appliance:Node Info", "description": "The NodeInfo object is designed to store the cluster node information of the Intersight Appliance. Created during the appliance's setup, NodeInfo objects are updated periodically to reflect the status of each node within the cluster.\n#### Purpose\nNodeInfo serves as an informative entity that provides details about individual nodes in the Intersight Appliance cluster. It includes crucial information such as node IDs, hostnames, IP configurations, and operational status, thus facilitating node management and monitoring.\n#### Key Concepts\n- **Cluster Node Representation:** Each NodeInfo object corresponds to a node within the Intersight Appliance cluster, providing node-specific data.\n- **Read-Only Data:** Ensures that node information is accessible without the risk of unauthorized changes.\n- **Identity Management:** Utilizes system-assigned unique IDs to maintain node identity and facilitate tracking.\n- **Network Configuration:** Captures both IPv4 and IPv6 configurations, supporting comprehensive network management.", "x-allOf-name": "appliance.NodeInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NodeInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.NodeInfo" ], "default": "appliance.NodeInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.NodeInfo" ], "default": "appliance.NodeInfo", "x-enum-as-string": true }, "DeploymentSize": { "description": "Current running deployment size for the Intersight Appliance node. Eg. small, medium, large etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Hostname": { "description": "Cluster node's FQDN or IP address.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeId": { "description": "System assigned unique ID of the Intersight Appliance node. The system incrementally assigns identifiers to each node in the Intersight Appliance cluster starting with a value of 1.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NodeIpV4Config": { "description": "IPv4 subnet and gateway configuration of the Intersight Appliance node.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.IpV4Interface", "readOnly": true, "x-omitempty": true }, "NodeIpV6Config": { "description": "IPv6 subnet and gateway configuration of the Intersight Appliance node.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.IpV6Interface", "readOnly": true, "x-omitempty": true }, "NodeType": { "description": "The node type of Intersight Virtual Appliance.\n* `standalone` - Single Node Intersight Virtual Appliance.\n* `management` - Management node type when Intersight Virtual Appliance is running as management-worker deployment.\n* `hamanagement` - Management node type when Intersight Virtual Appliance is running as multi node HA deployment.\n* `metrics` - Metrics node when Intersight Virtual Appliance is running management-metrics node.", "type": "string", "enum": [ "standalone", "management", "hamanagement", "metrics" ], "default": "standalone", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the Intersight Appliance node.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.NodeInfo.List": { "title": "List of 'appliance.NodeInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.NodeInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.NodeInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.NodeInfo" }, "nullable": true } } } ] }, "appliance.NodeIopsMetric.Response": { "description": "The response body of a HTTP GET request for the 'appliance.NodeIopsMetric' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.NodeIopsMetric' resources.", "x-one-of-name": "appliance.NodeIopsMetric.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.NodeIopsMetric.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.NodeIopsMetric": { "title": "Appliance:Node Iops Metric", "description": "Input/Output operations per second (IOPS) metrics for Intersight Appliance nodes. \nMeasures the aggregate rate of disk read and write operations, providing insights \ninto storage subsystem performance and I/O workload patterns across the cluster.", "x-allOf-name": "appliance.NodeIopsMetric", "allOf": [ { "$ref": "#/components/schemas/appliance.NodeMetricBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NodeIopsMetric', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.NodeIopsMetric" ], "default": "appliance.NodeIopsMetric", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.NodeIopsMetric" ], "default": "appliance.NodeIopsMetric", "x-enum-as-string": true }, "Iops": { "description": "Aggregate input/output operations per second.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.NodeIopsMetric.List": { "title": "List of 'appliance.NodeIopsMetric' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.NodeIopsMetric' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.NodeIopsMetric' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.NodeIopsMetric" }, "nullable": true } } } ] }, "appliance.NodeIpInfo": { "title": "Appliance:Node Ip Info", "description": "NodeInfo contains the hostname, ip address, and node number for a node.", "x-allOf-name": "appliance.NodeIpInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NodeIpInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.NodeIpInfo" ], "default": "appliance.NodeIpInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.NodeIpInfo" ], "default": "appliance.NodeIpInfo", "x-enum-as-string": true }, "Gateway": { "description": "Gateway ip address of the cluster node.", "type": "string", "readOnly": true, "x-omitempty": true }, "Hostname": { "description": "Hostname of the cluster node.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpAddress": { "description": "Ip address of the cluster node.", "type": "string", "readOnly": true, "x-omitempty": true }, "Netmask": { "description": "Netmask of the cluster node.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeId": { "description": "Id number of the cluster node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NodeMoid": { "description": "Moid of the corresponding appliance.ClusterInfo or appliance.NodeInfo mo.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeType": { "description": "The node type of Intersight Virtual Appliance.\n* `standalone` - Single Node Intersight Virtual Appliance.\n* `management` - Management node type when Intersight Virtual Appliance is running as management-worker deployment.\n* `hamanagement` - Management node type when Intersight Virtual Appliance is running as multi node HA deployment.\n* `metrics` - Metrics node when Intersight Virtual Appliance is running management-metrics node.", "type": "string", "enum": [ "standalone", "management", "hamanagement", "metrics" ], "default": "standalone", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the cluster node.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.NodeMetricBase": { "title": "Appliance:Node Metric Base", "description": "Base class for all metrics collected from Intersight Appliance nodes.", "x-allOf-name": "appliance.NodeMetricBase", "allOf": [ { "$ref": "#/components/schemas/appliance.MetricBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NodeMetricBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "appliance.CpuUtilization", "appliance.MemoryUtilization", "appliance.NodeIopsMetric" ], "x-enum-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": [ "appliance.CpuUtilization", "appliance.MemoryUtilization", "appliance.NodeIopsMetric" ], "x-enum-as-string": true }, "NodeHostname": { "description": "Hostname of the Intersight Appliance node. This human-readable identifier \ncorresponds to the Kubernetes node name used for metric queries and provides \nan intuitive way for users to correlate resource utilization data \nwith specific physical or virtual machines in the cluster topology.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeId": { "description": "System assigned unique ID of the Intersight Appliance node.\nThe system incrementally assigns identifiers to each node in\nthe Intersight Appliance cluster starting with a value of 1.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.NodeOpStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.NodeOpStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.NodeOpStatus' resources.", "x-one-of-name": "appliance.NodeOpStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.NodeOpStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.NodeOpStatus.Relationship": { "description": "A relationship to the 'appliance.NodeOpStatus' resource, or the expanded 'appliance.NodeOpStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.NodeOpStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.NodeOpStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.NodeOpStatus": { "title": "Appliance:Node Op Status", "description": "The NodeOpStatus object captures the status of individual nodes within the Intersight Appliance. It is essential for understanding node-specific operational metrics and performance indicators.\n#### Purpose\nNodeOpStatus focuses on node-level health and readiness, providing detailed metrics such as CPU and memory usage, file system status, and network connectivity within a cluster.\n#### Key Concepts\n- **Node Health:** Assesses individual nodes' operational status, incorporating checks that reflect Critical, Warning, or Operational states.\n- **Resource Monitoring:** Reports on CPU and memory usage to optimize node performance and readiness for hosting applications.\n- **Cluster Connectivity:** Evaluates network status among nodes, ensuring effective communication and data exchange.", "x-allOf-name": "appliance.NodeOpStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NodeOpStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.NodeOpStatus" ], "default": "appliance.NodeOpStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.NodeOpStatus" ], "default": "appliance.NodeOpStatus", "x-enum-as-string": true }, "ClusterNetworkStatus": { "type": "array", "items": { "description": "Time to ping other nodes in a multinode cluster.", "$ref": "#/components/schemas/appliance.NetworkStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "CpuUsage": { "description": "Percentage of CPU currently in use.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "DeploymentSize": { "description": "Current running deployment size for the Intersight Appliance node. Eg. small, medium, large etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "MemUsage": { "description": "Percentage of memory currently in use.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "NodeHostname": { "description": "Hostname of the Intersight Appliance node.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeId": { "description": "System assigned unique ID of the Intersight Appliance node.\nThe system incrementally assigns identifiers to each node in\nthe Intersight Appliance cluster starting with a value of 1.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NodeState": { "description": "State of the node in terms of its readiness to host Kubernetes pods.\n* `Down` - The node is yet to come up and join as a member of theKubernetes cluster.\n* `Preparing` - The node has come up and joined the Kubernetes cluster,preparing to host Kubernetes pods.\n* `Ready` - The node is ready to host Kubernetes pods.", "type": "string", "enum": [ "Down", "Preparing", "Ready" ], "default": "Down", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the Intersight Appliance node.\nOperational status is based on the result of the status\nchecks. If result of any check is Critical, then its\nvalue is Impaired. Otherwise, if result of any check is\nWarning, then its value is AttentionNeeded. If all\nchecks are OK, then its value is Operational.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "FileSystemOpStatuses": { "deprecated": true, "x-sunset": "2027-03-01", "description": "An array of relationships to applianceFileSystemOpStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.FileSystemOpStatus.Relationship" }, "nullable": true, "readOnly": true }, "FileSystemOpSummary": { "$ref": "#/components/schemas/appliance.FileSystemOpSummary.Relationship", "description": "A reference to a applianceFileSystemOpSummary resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkLinkStatuses": { "description": "An array of relationships to applianceNetworkLinkStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.NetworkLinkStatus.Relationship" }, "nullable": true, "readOnly": true }, "NodeInfo": { "$ref": "#/components/schemas/appliance.NodeInfo.Relationship", "description": "A reference to a applianceNodeInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 }, "SystemOpStatus": { "$ref": "#/components/schemas/appliance.SystemOpStatus.Relationship", "description": "A reference to a applianceSystemOpStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.NodeOpStatus.List": { "title": "List of 'appliance.NodeOpStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.NodeOpStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.NodeOpStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.NodeOpStatus" }, "nullable": true } } } ] }, "appliance.NodeStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.NodeStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.NodeStatus' resources.", "x-one-of-name": "appliance.NodeStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.NodeStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.NodeStatus.Relationship": { "description": "A relationship to the 'appliance.NodeStatus' resource, or the expanded 'appliance.NodeStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.NodeStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.NodeStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.NodeStatus": { "title": "Appliance:Node Status", "description": "Status of an Intersight Appliance node.", "x-allOf-name": "appliance.NodeStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NodeStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.NodeStatus" ], "default": "appliance.NodeStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.NodeStatus" ], "default": "appliance.NodeStatus", "x-enum-as-string": true }, "CpuUsage": { "description": "Percentage of CPU currently in use.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "MemUsage": { "description": "Percentage of memory currently in use.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "NodeId": { "description": "System assigned unique ID of the Intersight Appliance node.\nThe system incrementally assigns identifiers to each node in\nthe Intersight Appliance cluster starting with a value of 1.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NodeState": { "description": "State of the node in terms of its readiness to host Kubernetes pods.\n* `Down` - The node is yet to come up and join as a member of theKubernetes cluster.\n* `Preparing` - The node has come up and joined the Kubernetes cluster,preparing to host Kubernetes pods.\n* `Ready` - The node is ready to host Kubernetes pods.", "type": "string", "enum": [ "Down", "Preparing", "Ready" ], "default": "Down", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the Intersight Appliance node.\nOperational status is based on the result of the status\nchecks. If result of any check is Critical, then its\nvalue is Impaired. Otherwise, if result of any check is\nWarning, then its value is AttentionNeeded. If all\nchecks are OK, then its value is Operational.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "StatusChecks": { "type": "array", "items": { "description": "A collection of the status checks performed.", "$ref": "#/components/schemas/appliance.StatusCheck", "readOnly": true, "x-omitempty": true }, "nullable": true }, "FileSystemStatuses": { "description": "An array of relationships to applianceFileSystemStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.FileSystemStatus.Relationship" }, "nullable": true, "readOnly": true }, "NodeInfo": { "$ref": "#/components/schemas/appliance.NodeInfo.Relationship", "description": "A reference to a applianceNodeInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SystemStatus": { "$ref": "#/components/schemas/appliance.SystemStatus.Relationship", "description": "A reference to a applianceSystemStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.NodeStatus.List": { "title": "List of 'appliance.NodeStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.NodeStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.NodeStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.NodeStatus" }, "nullable": true } } } ] }, "appliance.NodeTelemetry.Response": { "description": "The response body of a HTTP GET request for the 'appliance.NodeTelemetry' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.NodeTelemetry' resources.", "x-one-of-name": "appliance.NodeTelemetry.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.NodeTelemetry.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.NodeTelemetry": { "title": "Appliance:Node Telemetry", "description": "NodeTelemetry represents the operational status of an Assist node,\nincluding CPU, memory, and disk usage metrics collected from Prometheus.", "x-allOf-name": "appliance.NodeTelemetry", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NodeTelemetry', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.NodeTelemetry" ], "default": "appliance.NodeTelemetry", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.NodeTelemetry" ], "default": "appliance.NodeTelemetry", "x-enum-as-string": true }, "CpuUsage": { "description": "CpuUsage indicates the operational status of CPU utilization on the Assist node.\nValues are Optimal, Warning, or Critical based on configured thresholds.\n* `Optimal` - Resource usage is within normal operating parameters.\n* `Warning` - Resource usage has exceeded warning thresholds and attention may be needed.\n* `Critical` - Resource usage has exceeded critical thresholds and immediate attention is required.", "type": "string", "enum": [ "Optimal", "Warning", "Critical" ], "default": "Optimal", "readOnly": true, "x-omitempty": true }, "Instance": { "description": "The instance identifier from which the metrics were collected.", "type": "string", "readOnly": true, "x-omitempty": true }, "MemoryUsage": { "description": "MemoryUsage indicates the operational status of memory utilization on the Assist node.\nValues are Optimal, Warning, or Critical based on configured thresholds.\n* `Optimal` - Resource usage is within normal operating parameters.\n* `Warning` - Resource usage has exceeded warning thresholds and attention may be needed.\n* `Critical` - Resource usage has exceeded critical thresholds and immediate attention is required.", "type": "string", "enum": [ "Optimal", "Warning", "Critical" ], "default": "Optimal", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "appliance.NodeTelemetry.List": { "title": "List of 'appliance.NodeTelemetry' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.NodeTelemetry' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.NodeTelemetry' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.NodeTelemetry" }, "nullable": true } } } ] }, "appliance.NodeUtilizationMetric": { "title": "Appliance:Node Utilization Metric", "description": "Base class for percentage-based utilization metrics collected from Intersight Appliance nodes.", "x-allOf-name": "appliance.NodeUtilizationMetric", "allOf": [ { "$ref": "#/components/schemas/appliance.NodeMetricBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.NodeUtilizationMetric', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "appliance.CpuUtilization", "appliance.MemoryUtilization" ], "x-enum-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": [ "appliance.CpuUtilization", "appliance.MemoryUtilization" ], "x-enum-as-string": true }, "Utilization": { "description": "The percent utilization of the metric.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.ReleaseNote.Response": { "description": "The response body of a HTTP GET request for the 'appliance.ReleaseNote' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.ReleaseNote' resources.", "x-one-of-name": "appliance.ReleaseNote.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.ReleaseNote.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.ReleaseNote": { "title": "Appliance:Release Note", "description": "ReleaseUpdate managed the object provides the information preview (new features and bug fixes) for one pending upgrade.", "x-allOf-name": "appliance.ReleaseNote", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.ReleaseNote', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.ReleaseNote" ], "default": "appliance.ReleaseNote", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.ReleaseNote" ], "default": "appliance.ReleaseNote", "x-enum-as-string": true }, "Notes": { "type": "array", "items": { "description": "Notes list all the upgrade notes for one upgrade.", "$ref": "#/components/schemas/onprem.UpgradeNote", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Version": { "description": "Version number of the pending upgrade.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.ReleaseNote.List": { "title": "List of 'appliance.ReleaseNote' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.ReleaseNote' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.ReleaseNote' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.ReleaseNote" }, "nullable": true } } } ] }, "appliance.RemoteFileImport.Response": { "description": "The response body of a HTTP GET request for the 'appliance.RemoteFileImport' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.RemoteFileImport' resources.", "x-one-of-name": "appliance.RemoteFileImport.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.RemoteFileImport.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.RemoteFileImport": { "title": "Appliance:Remote File Import", "description": "The RemoteFileImport object supports the import of firmware images to the Intersight Appliance. It facilitates remote requests via SCP or SFTP to download files.\n#### Purpose\nRemoteFileImport provides a mechanism for importing firmware images, enabling administrators to perform remote file transfers to the appliance. It supports both SCP and SFTP protocols for secure and efficient file management.\n#### Key Concepts\n- **Remote Transfers:** Facilitates SCP and SFTP requests, allowing secure remote file imports.\n- **Protocol Flexibility:** Supports multiple transfer protocols, providing adaptability to different network environments.\n- **Integration with Accounts:** Aligns file import processes with account management, ensuring secure and authorized operations.", "x-allOf-name": "appliance.RemoteFileImport", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.RemoteFileImport', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.RemoteFileImport" ], "default": "appliance.RemoteFileImport", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.RemoteFileImport" ], "default": "appliance.RemoteFileImport", "x-enum-as-string": true }, "Filename": { "description": "The name of the file to be imported.", "type": "string", "x-omitempty": true }, "Hostname": { "description": "The hostname of the machine where the file is located.", "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 }, "Password": { "description": "Password for remote requiest.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Path": { "description": "The port that should be used for the remote request.", "type": "string", "x-omitempty": true }, "Port": { "description": "The port that should be used for the remote request.", "type": "integer", "format": "int64", "x-omitempty": true }, "Protocol": { "description": "Specifies if this is an scp or sftp request.\n* `scp` - Secure Copy Protocol (SCP) to access the file server.\n* `sftp` - SSH File Transfer Protocol (SFTP) to access file server.\n* `cifs` - Common Internet File System (CIFS) Protocol to access file server.\n* `local` - Backup file is stored in Intersight Appliance.", "type": "string", "enum": [ "scp", "sftp", "cifs", "local" ], "default": "scp", "x-omitempty": true }, "Username": { "description": "The username for the remote request.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.RemoteFileImport.List": { "title": "List of 'appliance.RemoteFileImport' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.RemoteFileImport' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.RemoteFileImport' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.RemoteFileImport" }, "nullable": true } } } ] }, "appliance.Restore.Response": { "description": "The response body of a HTTP GET request for the 'appliance.Restore' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.Restore' resources.", "x-one-of-name": "appliance.Restore.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.Restore.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.Restore": { "title": "Appliance:Restore", "description": "The Restore object is crucial for handling system restoration requests, enabling recovery operations to maintain system stability and data accuracy.\n#### Purpose\nThe Restore object facilitates the process of restoring system data from backups, ensuring timely and accurate recovery following disruptions or data loss.\n#### Key Concepts\n- **Process Tracking:** Monitors restore processes from start to finish, providing insights into operation progress and status.\n- **Single Active Instance:** Ensures only one active restoration operation occurs, preventing overlap and conflicts in recovery efforts.\n- **Secure Operations:** Utilizes secure communication protocols for data transfer, promoting reliability and safety during restoration.\n- **Relationship Management:** Maintains connections to account structures, supporting coherent and systematic restore operations.", "x-allOf-name": "appliance.Restore", "allOf": [ { "$ref": "#/components/schemas/appliance.BackupBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.Restore', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.Restore" ], "default": "appliance.Restore", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.Restore" ], "default": "appliance.Restore", "x-enum-as-string": true }, "ElapsedTime": { "description": "Elapsed time in seconds since the restore process has started.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date and time of the restore process.", "type": "string", "format": "date-time", "readOnly": true, "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 }, "Messages": { "type": "array", "items": { "description": "Messages generated during the restore process.", "type": "string", "x-omitempty": true }, "nullable": true }, "Password": { "description": "Password for authenticating with the file server.", "type": "string", "pattern": "^$|^[^`]+$", "writeOnly": true, "x-omitempty": true }, "StartTime": { "description": "Start date and time of the restore process.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the restore managed object.\n* `Started` - Backup or restore process has started.\n* `Created` - Backup or restore is in created state.\n* `Failed` - Backup or restore process has failed.\n* `Completed` - Backup or restore process has completed.\n* `Copied` - Backup file has been copied.\n* `Cleanup Failed` - Cleanup of the old backup has failed.", "type": "string", "enum": [ "Started", "Created", "Failed", "Completed", "Copied", "Cleanup Failed" ], "default": "Started", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "appliance.Restore.List": { "title": "List of 'appliance.Restore' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.Restore' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.Restore' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.Restore" }, "nullable": true } } } ] }, "appliance.SetupInfo.Response": { "description": "The response body of a HTTP GET request for the 'appliance.SetupInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.SetupInfo' resources.", "x-one-of-name": "appliance.SetupInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.SetupInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.SetupInfo": { "title": "Appliance:Setup Info", "description": "SetupInfo will have only one managed object. SetupInfo managed object is to keep\ntrack of the Intersight Appliance's setup information and guide the UI through\nthe initial configuration of the Intersight Appliance.\nThe SetupInfo managed object is created during the Intersight Appliance setup.\nThe Intersight UI uses this object to store the initial configuration states\nthat the user has completed. If the user closes the Intersight UI without\nfinishing all the initial configuration, then the Intersight UI will use this\nmanaged object to display the next configuration that the user needs to complete\nwhen the user uses the Intersight Appliance next time.", "x-allOf-name": "appliance.SetupInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.SetupInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.SetupInfo" ], "default": "appliance.SetupInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.SetupInfo" ], "default": "appliance.SetupInfo", "x-enum-as-string": true }, "BuildType": { "description": "Build type of the Intersight Appliance setup (e.g. release or debug).", "type": "string", "readOnly": true, "x-omitempty": true }, "Capabilities": { "type": "array", "items": { "description": "The array of capabilities, that enable key-value metadata for Intersight Appliance. For example, Intersight Assist is one of the capabilities.", "$ref": "#/components/schemas/appliance.KeyValuePair", "readOnly": true, "x-omitempty": true }, "nullable": true }, "CloudUrl": { "description": "URL of the Intersight to which this Intersight Appliance is connected to.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeploymentMode": { "description": "Indicates where Intersight Appliance is installed in air-gapped or connected mode.\nIn connected mode, Intersight Appliance is claimed by Intesight SaaS.\nIn air-gapped mode, Intersight Appliance does not connect to any Cisco services.\n* `Connected` - In connected mode, Intersight Appliance connects to Intersight SaaS and other cisco.com services.\n* `Private` - In private mode, Intersight Appliance does not connect to Intersight SaaS or any cisco.com services.", "type": "string", "enum": [ "Connected", "Private" ], "default": "Connected", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date of the Intersight Appliance's initial setup.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LatestVersion": { "description": "The most recent version which Intersight Appliance can upgrade to.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinCpu": { "description": "The minimum cpu required of the node in cluster.", "type": "integer", "format": "int64", "x-omitempty": true }, "MinRam": { "description": "The minimum ram required of the node in cluster.", "type": "integer", "format": "int64", "x-omitempty": true }, "SetupStates": { "type": "array", "items": { "description": "Collection of completed initial wizard setup states. Some examples of the wizard states are 'user account creation', 'licence registration' etc.", "type": "string", "x-omitempty": true }, "nullable": true }, "StartTime": { "description": "Start date of the Intersight Appliance's initial setup.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.SetupInfo.List": { "title": "List of 'appliance.SetupInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.SetupInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.SetupInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.SetupInfo" }, "nullable": true } } } ] }, "appliance.StatusCheck": { "title": "Appliance:Status Check", "description": "Status check on an Intersight Appliance entity.", "x-allOf-name": "appliance.StatusCheck", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.StatusCheck', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.StatusCheck" ], "default": "appliance.StatusCheck", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.StatusCheck" ], "default": "appliance.StatusCheck", "x-enum-as-string": true }, "Code": { "description": "Unique identifier of the status check.", "type": "string", "x-omitempty": true }, "Result": { "description": "Result of this status check.\n* `OK` - Result of the check is OK.\n* `Warning` - Result of the check is Warning.\n* `Critical` - Result of the check is Critical.\n* `Info` - Result of the check is low.", "type": "string", "enum": [ "OK", "Warning", "Critical", "Info" ], "default": "OK", "x-omitempty": true } } } ] }, "appliance.SystemInfo.Response": { "description": "The response body of a HTTP GET request for the 'appliance.SystemInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.SystemInfo' resources.", "x-one-of-name": "appliance.SystemInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.SystemInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.SystemInfo.Relationship": { "description": "A relationship to the 'appliance.SystemInfo' resource, or the expanded 'appliance.SystemInfo' resource, or the 'null' value.", "x-one-of-name": "appliance.SystemInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.SystemInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.SystemInfo": { "title": "Appliance:System Info", "description": "The SystemInfo object represents the Intersight Appliance's system information. It is a singleton managed object that is created during the setup of the Intersight Appliance. It is periodically updated with up-to-date cluster status information by the appliance itself.\n#### Purpose\nThe SystemInfo object serves as a central repository of the Intersight Appliance's system-level data. This provides essential details such as the appliance's serial ID, hostname, IP address, and operational status. By doing so, it facilitates the management and monitoring of the appliance's health and connectivity.\n#### Key Concepts\n- **Singleton Model:** Ensures that only one instance of the SystemInfo object exists, maintaining a single source of truth for system information.\n- **Automated Updates:** The appliance automatically updates the SystemInfo object, ensuring that the data reflects the current state of the cluster.\n- **Access Control:** Provides read-only access to critical system information, safeguarding against unauthorized modifications.\n- **Operational Insight:** Offers insights into the appliance's deployment size, version, and cluster status, aiding in effective system management.", "x-allOf-name": "appliance.SystemInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.SystemInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.SystemInfo" ], "default": "appliance.SystemInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.SystemInfo" ], "default": "appliance.SystemInfo", "x-enum-as-string": true }, "CloudConnStatus": { "description": "Connection state of the Intersight Appliance to the Intersight.\n* `` - The target details have been persisted but Intersight has not yet attempted to connect to the target.\n* `Connected` - Intersight is able to establish a connection to the target and initiate management activities.\n* `NotConnected` - Intersight is unable to establish a connection to the target.\n* `ClaimInProgress` - Claim of the target is in progress. A connection to the target has not been fully established.\n* `UnclaimInProgress` - Unclaim of the target is in progress. Intersight is able to connect to the target and all management operations are supported.\n* `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. Also indicates the failure to claim Targets of type HTTP Endpoint in Intersight.\n* `Claimed` - Target of type HTTP Endpoint is successfully claimed in Intersight. Currently no validation is performed to verify the Target connectivity from Intersight at the time of creation. However invoking API from Intersight Orchestrator fails if this Target is not reachable from Intersight or if Target API credentials are incorrect.\n* `PreClaimed` - Target has been pre-claimed and is pending claim completion. Pre-claimed targets are pre-provisioned before endpoint is available to connect to Intersight, once target connects the claim can be completed by providing the security token to the pre-claim API.", "type": "string", "enum": [ "", "Connected", "NotConnected", "ClaimInProgress", "UnclaimInProgress", "Unclaimed", "Claimed", "PreClaimed" ], "default": "", "readOnly": true, "x-omitempty": true }, "ClusterStatus": { "description": "Current status of cluster operation on the Intersight Appliance.\n* `none` - The Intersight Appliance is running in standalone mode.\n* `active` - The Intersight Appliance is running as part of a cluster.\n* `pending` - The Intersight Appliance is currently forming a cluster.\n* `failed` - The Intersight Appliance failed to form a cluster.", "type": "string", "enum": [ "none", "active", "pending", "failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "DeploymentSize": { "description": "Current running deployment size for the Intersight Appliance cluster. Eg. small, medium, large etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Hostname": { "description": "Publicly accessible FQDN of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "InitDone": { "description": "Indicates that the setup initialization process has been completed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IpAddress": { "description": "Publicly accessible IP address of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsVirtualIp": { "description": "Specifies whether this Intersight Appliance is using a virtual ip address.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the Intersight Appliance cluster.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "SerialId": { "description": "SerialId of the Intersight Appliance. SerialId is generated when the Intersight Appliance is setup. It is a unique UUID string, and serialId will not change for the life time of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "TimeZone": { "description": "Timezone of the Intersight Appliance.\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 }, "Version": { "description": "Current software version of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "appliance.SystemInfo.List": { "title": "List of 'appliance.SystemInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.SystemInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.SystemInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.SystemInfo" }, "nullable": true } } } ] }, "appliance.SystemOpStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.SystemOpStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.SystemOpStatus' resources.", "x-one-of-name": "appliance.SystemOpStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.SystemOpStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.SystemOpStatus.Relationship": { "description": "A relationship to the 'appliance.SystemOpStatus' resource, or the expanded 'appliance.SystemOpStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.SystemOpStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.SystemOpStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.SystemOpStatus": { "title": "Appliance:System Op Status", "description": "The SystemOpStatus object represents the status of the Intersight Appliance within a system. This provides a comprehensive view of the appliance's operational state, including the health and performance of its nodes and applications.\n#### Purpose\nSystemOpStatus serves as the primary indicator of the appliance's operational health. It encompasses the results of status checks across various components, determining the overall status as Operational, AttentionNeeded, or Impaired based on these checks.\n#### Key Concepts\n- **Operational Status:** Defines the health of the appliance, influenced by checks on nodes, applications, and system components.\n- **Node and Application Monitoring:** Tracks the number of nodes and applications that require attention or are impaired.\n- **Alert System:** Utilizes certificate expiry dates to raise alarms, ensuring timely updates and security compliance.\n- **Relationships:** Links to system information, applications, groups, and accounts to provide a holistic overview.", "x-allOf-name": "appliance.SystemOpStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.SystemOpStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.SystemOpStatus" ], "default": "appliance.SystemOpStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.SystemOpStatus" ], "default": "appliance.SystemOpStatus", "x-enum-as-string": true }, "OperationalStatus": { "description": "Operational status of the Intersight Appliance.\nOperational status is based on the result of the status\nchecks. If result of any check is Critical, then its\nvalue is Impaired. Otherwise, if result of any check is\nWarning, then its value is AttentionNeeded. If all\nchecks are OK, then its value is Operational.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "AppOpStatuses": { "description": "An array of relationships to applianceAppOpStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.AppOpStatus.Relationship" }, "nullable": true, "readOnly": true }, "GroupOpStatuses": { "description": "An array of relationships to applianceGroupOpStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.GroupOpStatus.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 }, "SystemInfo": { "$ref": "#/components/schemas/appliance.SystemInfo.Relationship", "description": "A reference to a applianceSystemInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.SystemOpStatus.List": { "title": "List of 'appliance.SystemOpStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.SystemOpStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.SystemOpStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.SystemOpStatus" }, "nullable": true } } } ] }, "appliance.SystemStatus.Response": { "description": "The response body of a HTTP GET request for the 'appliance.SystemStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.SystemStatus' resources.", "x-one-of-name": "appliance.SystemStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.SystemStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.SystemStatus.Relationship": { "description": "A relationship to the 'appliance.SystemStatus' resource, or the expanded 'appliance.SystemStatus' resource, or the 'null' value.", "x-one-of-name": "appliance.SystemStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.SystemStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.SystemStatus": { "title": "Appliance:System Status", "description": "Status of the Intersight Appliance.", "x-allOf-name": "appliance.SystemStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.SystemStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.SystemStatus" ], "default": "appliance.SystemStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.SystemStatus" ], "default": "appliance.SystemStatus", "x-enum-as-string": true }, "OperationalStatus": { "description": "Operational status of the Intersight Appliance.\nOperational status is based on the result of the status\nchecks. If result of any check is Critical, then its\nvalue is Impaired. Otherwise, if result of any check is\nWarning, then its value is AttentionNeeded. If all\nchecks are OK, then its value is Operational.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "StatusChecks": { "type": "array", "items": { "description": "A collection of the status checks performed.", "$ref": "#/components/schemas/appliance.StatusCheck", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AppStatuses": { "description": "An array of relationships to applianceAppStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.AppStatus.Relationship" }, "nullable": true, "readOnly": true }, "GroupStatuses": { "description": "An array of relationships to applianceGroupStatus resources.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.GroupStatus.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 }, "SystemInfo": { "$ref": "#/components/schemas/appliance.SystemInfo.Relationship", "description": "A reference to a applianceSystemInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.SystemStatus.List": { "title": "List of 'appliance.SystemStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.SystemStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.SystemStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.SystemStatus" }, "nullable": true } } } ] }, "appliance.Upgrade.Response": { "description": "The response body of a HTTP GET request for the 'appliance.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 'appliance.Upgrade' resources.", "x-one-of-name": "appliance.Upgrade.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.Upgrade.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.Upgrade.Relationship": { "description": "A relationship to the 'appliance.Upgrade' resource, or the expanded 'appliance.Upgrade' resource, or the 'null' value.", "x-one-of-name": "appliance.Upgrade.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/appliance.Upgrade" } ], "discriminator": { "propertyName": "ClassId" } }, "appliance.Upgrade": { "title": "Appliance:Upgrade", "description": "The Upgrade object is a crucial component within the Intersight Appliance's software management system, responsible for tracking and managing software upgrades. It facilitates the seamless transition of the appliance software to newer versions, ensuring both functionality and security enhancements are applied effectively.\n#### Purpose\nThe Upgrade object automates the process of software upgrades by creating managed objects whenever there's a pending software upgrade. It allows users to modify active Upgrade objects to reset the upgrade start time, providing flexibility in scheduling upgrades.\n#### Key Concepts\n- **Automated Creation:** Automatically generates Upgrade objects when new software versions are detected, streamlining the upgrade process.\n- **User Modification:** Offers users the ability to adjust upgrade start times, accommodating specific scheduling needs within set grace period limits.\n- **Dependency Tracking:** Maintains relationships with other upgrade instances to handle dependencies and ensure smooth transitions.\n- **Status Monitoring:** Provides comprehensive status updates and error codes, aiding in troubleshooting and decision-making regarding retries.", "x-allOf-name": "appliance.Upgrade", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.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": [ "appliance.Upgrade" ], "default": "appliance.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": [ "appliance.Upgrade" ], "default": "appliance.Upgrade", "x-enum-as-string": true }, "Active": { "description": "Indicates if the software upgrade is active or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "AllNodesPingable": { "description": "True if all nodes in cluster are pingable, otherwise false.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "AutoCreated": { "description": "Indicates that the request was automatically created by the system.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "CompletedPhases": { "type": "array", "items": { "description": "Collection of the completed software upgrade phases.", "$ref": "#/components/schemas/onprem.UpgradePhase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "CurrentPhase": { "description": "Current phase of the Intersight Appliance's software upgrade.", "$ref": "#/components/schemas/onprem.UpgradePhase", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Description of the software upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "ElapsedTime": { "description": "Elapsed time in seconds during the software upgrade.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date of the software upgrade.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ErrorCode": { "description": "Error code for Intersight Appliance's software upgrade. In case of failure - this code will help decide if software upgrade can be retried.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Fingerprint": { "description": "Software upgrade manifest's fingerprint.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsRollingBack": { "description": "Track if software upgrade is upgrading or rolling back.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsUserTriggered": { "description": "Indicates if the upgrade is triggered by user or due to schedule.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Messages": { "type": "array", "items": { "description": "Messages generated during the software upgrade process.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NodeInfo": { "type": "array", "items": { "description": "Node ip info, which contains the ip addresses and hostnames of the other cluster nodes.", "$ref": "#/components/schemas/appliance.NodeIpInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PreviousInstallAttempts": { "description": "The number of previous failed install attempts of the same upgrade version.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RollbackNeeded": { "description": "Track if rollback is needed.", "type": "boolean", "default": false, "x-omitempty": true }, "RollbackPhases": { "type": "array", "items": { "description": "Collection of the completed software rollback phases.", "$ref": "#/components/schemas/onprem.UpgradePhase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RollbackStatus": { "description": "Status of the Intersight Appliance's software rollback status.", "type": "string", "readOnly": true, "x-omitempty": true }, "Services": { "type": "array", "items": { "description": "Services that are upgraded during the software upgrade process. For example, if the software upgrade has updates for five Intersight micro-services, then this field will have the names of those five micro-services.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "StartTime": { "description": "Start date of the software upgrade. UI can modify startTime to re-schedule an upgrade.", "type": "string", "format": "date-time", "x-omitempty": true }, "Status": { "description": "Status of the Intersight Appliance's software upgrade.", "type": "string", "x-omitempty": true }, "TotalNodes": { "description": "Total number of nodes this upgrade will run on.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalPhases": { "description": "TotalPhase represents the total number of the upgradePhases for one upgrade.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UiPackages": { "type": "array", "items": { "description": "Name of the UI packages that are upgraded. For example, if the software upgrade has updates for five Intersight micro-service UI packages, then this field will have the names of those five micro-services.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Version": { "description": "Software upgrade manifest's version.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." }, "ImageBundle": { "$ref": "#/components/schemas/appliance.ImageBundle.Relationship", "description": "A reference to a applianceImageBundle resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Requires": { "$ref": "#/components/schemas/appliance.Upgrade.Relationship", "description": "A reference to a applianceUpgrade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "appliance.Upgrade.List": { "title": "List of 'appliance.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.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 'appliance.Upgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.Upgrade" }, "nullable": true } } } ] }, "appliance.UpgradePolicy.Response": { "description": "The response body of a HTTP GET request for the 'appliance.UpgradePolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.UpgradePolicy' resources.", "x-one-of-name": "appliance.UpgradePolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.UpgradePolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.UpgradePolicy": { "title": "Appliance:Upgrade Policy", "description": "UpgradePolicy stores the Intersight Appliance's software upgrade policy. UpgradePolicy\nis a sinlgeton managed object. A default upgrade policy is created during the Intersight\nAppliance setup, and it is configured with an automatic upgrade policy.\nAutomatic upgrade policy lets the system start software upgrade after a pre-defined\nnumber of seconds set in the software manifest.\nScheduled upgrade policy lets the user start software upgrade at a specified schedule.\nHowever, scheduled time cannot be beyond the time limit enforced by the upgrade grace\nperiod set in the software manifest.", "x-allOf-name": "appliance.UpgradePolicy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.UpgradePolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.UpgradePolicy" ], "default": "appliance.UpgradePolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.UpgradePolicy" ], "default": "appliance.UpgradePolicy", "x-enum-as-string": true }, "AutoUpgrade": { "description": "Updates are installed automatically 2 weeks after detection, or 4 weeks if an appliance reboot is required.", "type": "boolean", "x-omitempty": true }, "BlackoutDatesEnabled": { "description": "Appliance will not be updated during the blocked dates.", "type": "boolean", "x-omitempty": true }, "BlackoutEndDate": { "description": "End date of the black out period.", "type": "string", "format": "date-time", "x-omitempty": true }, "BlackoutStartDate": { "description": "Start date of the black out period. The appliance will not be upgraded during this period.", "type": "string", "format": "date-time", "x-omitempty": true }, "DisruptiveGracePeriodWeek": { "description": "Updates that require an appliance reboot start automatically after the grace period ends.", "type": "integer", "format": "int64", "default": 4, "minimum": 1, "maximum": 6, "x-omitempty": true }, "EnableMetaDataSync": { "description": "Indicates if the updated metadata files should be synced immediately or at the next upgrade.", "type": "boolean", "default": true, "x-omitempty": true }, "IsCustomGracePeriodEnabled": { "description": "Waiting period before major and patch updates are triggered automatically.", "type": "boolean", "x-omitempty": true }, "IsSynced": { "description": "Flag to indicate software upgrade setting is synchronized with Intersight SaaS.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ManualInstallationStartTime": { "description": "Intersight Appliance manual upgrade start time.", "type": "string", "format": "date-time", "x-omitempty": true }, "NondisruptiveGracePeriodWeek": { "description": "Updates that do not require an appliance reboot start automatically after the grace period ends.", "type": "integer", "format": "int64", "default": 4, "minimum": 1, "maximum": 6, "x-omitempty": true }, "Schedule": { "description": "User defined schedule for upgrading the Intersight Appliance software.", "$ref": "#/components/schemas/onprem.Schedule", "x-omitempty": true }, "SoftwareDownloadType": { "description": "SoftwareDownloadType is used to indicate the kind of software download.\n* `unknown` - Indicates user setting of upgrade service to unknown.\n* `connected` - Indicates if the upgrade service is set to upload software to latest version automatically.\n* `manual` - Indicates if the upgrade service is set to upload software to user picked verison manually.", "type": "string", "enum": [ "unknown", "connected", "manual" ], "default": "unknown", "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.UpgradePolicy.List": { "title": "List of 'appliance.UpgradePolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.UpgradePolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.UpgradePolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.UpgradePolicy" }, "nullable": true } } } ] }, "appliance.UpgradeTracker.Response": { "description": "The response body of a HTTP GET request for the 'appliance.UpgradeTracker' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'appliance.UpgradeTracker' resources.", "x-one-of-name": "appliance.UpgradeTracker.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/appliance.UpgradeTracker.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "appliance.UpgradeTracker": { "title": "Appliance:Upgrade Tracker", "description": "The UpgradeTracker object is designed to monitor the history of software upgrades within the Intersight Appliance. It acts as a singleton object to facilitate alarm conditions and raise alarms in the event of failed upgrades.\n#### Purpose\nUpgradeTracker serves as a historical record of upgrade processes, focusing on the outcome and status of the last upgrade. It supports diagnostic and alert functions by providing clear indicators of upgrade failures. \n#### Key Concepts \n- **Failure Indication:** Tracks whether the last software upgrade was unsuccessful, serving as a basis for raising alarms and initiating corrective actions.\n- **Singleton Nature:** Operates as a single instance within the system, ensuring centralized management and consistency in tracking upgrade history.\n- **Alarm Integration:** Interfaces with alarm conditions to facilitate timely alerts and responses to upgrade issues.\n- **Version Documentation:** Records the version and descriptive details of failed upgrades, aiding in troubleshooting and resolution efforts.", "x-allOf-name": "appliance.UpgradeTracker", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.UpgradeTracker', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "appliance.UpgradeTracker" ], "default": "appliance.UpgradeTracker", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "appliance.UpgradeTracker" ], "default": "appliance.UpgradeTracker", "x-enum-as-string": true }, "Description": { "description": "A description of the upgrade or upgrade failure.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastUpgradeFailed": { "description": "Indicates if the last upgrade has failed or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Version of the failed upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "appliance.UpgradeTracker.List": { "title": "List of 'appliance.UpgradeTracker' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'appliance.UpgradeTracker' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'appliance.UpgradeTracker' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/appliance.UpgradeTracker" }, "nullable": true } } } ] }, "appliance.UtilizationMetric": { "title": "Appliance:Utilization Metric", "description": "A utilization metric represents the percentage utilization of a resource.", "x-allOf-name": "appliance.UtilizationMetric", "allOf": [ { "$ref": "#/components/schemas/appliance.MetricBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'appliance.UtilizationMetric', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "appliance.MetricsIngestionUtilization" ], "default": "appliance.MetricsIngestionUtilization", "x-enum-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": [ "appliance.MetricsIngestionUtilization" ], "default": "appliance.MetricsIngestionUtilization", "x-enum-as-string": true }, "Utilization": { "description": "The percent utilization of the metric.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true } } } ] }, "asset.AddressInformation": { "title": "Asset:Address Information", "description": "Type for saving the address information. It is used in asset.DeviceContractInformation object to save customer address.", "x-allOf-name": "asset.AddressInformation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.AddressInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.AddressInformation" ], "default": "asset.AddressInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.AddressInformation" ], "default": "asset.AddressInformation", "x-enum-as-string": true }, "Address1": { "description": "Address Line one of the address information. example \"PO BOX 641570\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Address2": { "description": "Address Line two of the address information. example \"Cisco Systems\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Address3": { "description": "Address Line three of the address information. example \"Cisco Systems\".", "type": "string", "readOnly": true, "x-omitempty": true }, "City": { "description": "City in which the address resides. example \"San Jose\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Country": { "description": "Country in which the address resides. example \"US\".", "type": "string", "readOnly": true, "x-omitempty": true }, "County": { "description": "County in which the address resides. example \"Washington County\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Location": { "description": "Location in which the address resides. example \"14852\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the user whose address is being populated.", "type": "string", "readOnly": true, "x-omitempty": true }, "PostalCode": { "description": "Postal Code in which the address resides. example \"95164-1570\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Province": { "description": "Province in which the address resides. example \"AB\".", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "State in which the address resides. example \"CA\".", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.AlarmSummary": { "title": "Asset:Alarm Summary", "description": "The summary of alarm counts based on alarm serverity.", "x-allOf-name": "asset.AlarmSummary", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.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": [ "asset.AlarmSummary" ], "default": "asset.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": [ "asset.AlarmSummary" ], "default": "asset.AlarmSummary", "x-enum-as-string": true }, "Critical": { "description": "The count of active 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 active alarms that have severity type Info.", "type": "integer", "format": "int64", "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 active alarms that have severity type Warning.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "asset.ApiKeyCredential": { "title": "Asset:Api Key Credential", "description": "API key based authentication.", "x-allOf-name": "asset.ApiKeyCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ApiKeyCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ApiKeyCredential" ], "default": "asset.ApiKeyCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ApiKeyCredential" ], "default": "asset.ApiKeyCredential", "x-enum-as-string": true }, "ApiKey": { "description": "This a secret API key which can be used for authentication purposes for different targets like Azure Enterprise Agreement.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsApiKeySet": { "description": "Indicates whether the value of the 'apiKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.ClaimSignature": { "title": "Asset:Claim Signature", "description": "A cryptographic signature that can be used to auto-claim a device connector into a user's account.", "x-allOf-name": "asset.ClaimSignature", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ClaimSignature', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "asset.ParentConnectionSignature", "asset.TargetSignature", "asset.Token" ], "x-enum-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": [ "asset.ParentConnectionSignature", "asset.TargetSignature", "asset.Token" ], "x-enum-as-string": true }, "Signature": { "description": "The result of signing the deviceId appended with the timeStamp fields with the devices private key.", "type": "string", "format": "byte", "x-omitempty": true }, "TimeStamp": { "description": "The time at which the signature was generated. Date is accurate to Intersights clock. Used to expire the signature.", "type": "string", "format": "date-time", "x-omitempty": true } } } ] }, "asset.ClaimToken.Response": { "description": "The response body of a HTTP GET request for the 'asset.ClaimToken' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.ClaimToken' resources.", "x-one-of-name": "asset.ClaimToken.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.ClaimToken.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.ClaimToken": { "title": "Asset:Claim Token", "description": "The ClaimToken object serves as a secure mechanism for onboarding and registering devices to an Intersight user account. It facilitates a streamlined connection process, allowing device connectors to authenticate and associate themselves with a specific user environment without requiring complex manual configuration or external dial-out procedures.\n#### Purpose\nA ClaimToken acts as a bridge between a physical or virtual device and the Intersight platform. Supplies the necessary credentials and instructions for a device connector to establish a secure link to the user's account, ensuring that device claiming is performed in a controlled and authorized manner.\n#### Key Concepts\n- **Simplified Onboarding:** Enables the claiming of devices into an Intersight account by providing a pre-configured token, removing the need for the appliance to perform manual outbound configuration. - **Security and Verification:** Incorporates cryptographic signatures to verify the legitimacy of the claim, ensuring that only authorized devices can be associated with an account. - **Access Control:** Management of claim tokens is restricted to specific privilege sets, such as Account Administrators and users with dedicated Claim Devices or Claim targets permissions, ensuring that only authorized personnel can initiate device registration. - **Lifecycle Management:** Includes built-in expiration logic to maintain security, ensuring that tokens remain valid only for a defined period and reducing the risk associated with long-lived or unused tokens.", "x-allOf-name": "asset.ClaimToken", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ClaimToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ClaimToken" ], "default": "asset.ClaimToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ClaimToken" ], "default": "asset.ClaimToken", "x-enum-as-string": true }, "Claim": { "description": "The claim generated to configure the device to connect and claim to the user account.", "type": "string", "x-omitempty": true }, "ExpirationDate": { "description": "The expiry time of the claim token, after this time any generated claims from this token are no longer valid.", "type": "string", "format": "date-time", "x-omitempty": true }, "User": { "$ref": "#/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." } } } ] }, "asset.ClaimToken.List": { "title": "List of 'asset.ClaimToken' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.ClaimToken' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.ClaimToken' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.ClaimToken" }, "nullable": true } } } ] }, "asset.ClientCertificateCredential": { "title": "Asset:Client Certificate Credential", "description": "A credential which performs authentication with TLS client certificates.", "x-allOf-name": "asset.ClientCertificateCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ClientCertificateCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ClientCertificateCredential" ], "default": "asset.ClientCertificateCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ClientCertificateCredential" ], "default": "asset.ClientCertificateCredential", "x-enum-as-string": true }, "ClientCertificate": { "description": "PEM encoded x509 client certificate used to authenticate with the target.", "type": "string", "x-omitempty": true }, "ClientKey": { "description": "PEM encoded private key used to authenticate with the target.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsClientKeySet": { "description": "Indicates whether the value of the 'clientKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.CloudConnection": { "title": "Asset:Cloud Connection", "description": "CloudConnection provides the necessary details for Intersight to connect to and authenticate with a target at a well-known service address. The service address is inferred based upon the target type. For example Amazon Web Services.", "x-allOf-name": "asset.CloudConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" } ] }, "asset.ClusterMember.Response": { "description": "The response body of a HTTP GET request for the 'asset.ClusterMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.ClusterMember' resources.", "x-one-of-name": "asset.ClusterMember.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.ClusterMember.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.ClusterMember.Relationship": { "description": "A relationship to the 'asset.ClusterMember' resource, or the expanded 'asset.ClusterMember' resource, or the 'null' value.", "x-one-of-name": "asset.ClusterMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.ClusterMember" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.ClusterMember": { "title": "Asset:Cluster Member", "description": "The ClusterMember object represents a node within a cluster of device connectors. This provides detailed insights into the individual members of a device cluster, supporting high availability and redundancy in device management.\n#### Purpose\nClusterMember facilitates the management of clustered devices by capturing connection details and leadership states of each node. It plays a crucial role in ensuring that device management is robust and scalable, supporting seamless failover and load balancing.\n#### Key Concepts\n- **Cluster Identity:** Maintains unique identities for each node within the cluster, ensuring precise tracking and management.\n- **Leadership Management:** Monitors leadership states within the cluster, supporting efficient failover and recovery processes.\n- **Connection Details:** Provides granular visibility into the connection status and configuration of each cluster member, enabling proactive management.", "x-allOf-name": "asset.ClusterMember", "allOf": [ { "$ref": "#/components/schemas/asset.DeviceConnection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ClusterMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ClusterMember" ], "default": "asset.ClusterMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ClusterMember" ], "default": "asset.ClusterMember", "x-enum-as-string": true }, "ConnectedHost": { "description": "The DNS hostname the device connector has used to connect to Intersight. Devices may be configured to connect to a set of DNS hostnames which all resolve to the same Intersight instance, the connected host is the latest hostname the device used to connect successfully to Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionFlapStatus": { "description": "Encapsulates key details used to identify devices experiencing connection flapping.", "$ref": "#/components/schemas/asset.ConnectionFlapStatus", "readOnly": true, "x-omitempty": true }, "Leadership": { "description": "The current leadershipstate of this member. Updated by the device connector on failover or leadership change. If a member is elected as Primary within the cluster this connection will be the same as the DeviceRegistration connection. E.g a message addressed to the DeviceRegistration will be forwarded to the ClusterMember connection.\n* `Unknown` - The node is unable to complete election or determine the current state. If the device has been registered before and the node has access to the current credentials, it will establish a connection to Intersight with limited capabilities that can be used to debug the HA failure from Intersight.\n* `Primary` - The node has been elected as the primary and will establish a connection to the Intersight service and accept all message types enabled for a primary node. There can only be one primary node in a given cluster, while the underlying platform may be active. If it is active, only one connector will assume the primary role.\n* `Secondary` - The node has been elected as a secondary node in the cluster. The device connector will establish a connection to the Intersight service with limited capabilities. E.g. file upload will be enabled, but requests to the underlying platform management will be disabled.", "type": "string", "enum": [ "Unknown", "Primary", "Secondary" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "LockedLeader": { "description": "Devices lock their leadership on failure to heartbeat with peers. Value acts as a third party tie breaker in election between nodes. Intersight enforces that only one cluster member exists with this value set to true.", "type": "boolean", "x-omitempty": true }, "MemberIdentity": { "description": "The unique identity of the member within the cluster. The identity is retrieved from the platform and reported by the device connector at connection time.", "type": "string", "readOnly": true, "x-omitempty": true }, "ParentClusterMemberIdentity": { "description": "The member idenity of the cluster member through which this device is connected if applicable.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sudi": { "description": "The SUDI status read from the Trust Anchor Module on a device.", "$ref": "#/components/schemas/asset.SudiInfo", "readOnly": true, "x-omitempty": true }, "Device": { "$ref": "#/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 } } } ] }, "asset.ClusterMember.List": { "title": "List of 'asset.ClusterMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.ClusterMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.ClusterMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.ClusterMember" }, "nullable": true } } } ] }, "asset.Connection": { "title": "Asset:Connection", "description": "A method for Intersight to connect to a managed target, including network connectivity and authentication details.", "x-allOf-name": "asset.Connection", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Connection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "asset.CloudConnection", "asset.HttpConnection", "asset.IntersightDeviceConnectorConnection", "asset.ScopedTargetConnection", "asset.SshConnection" ], "x-enum-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": [ "asset.CloudConnection", "asset.HttpConnection", "asset.IntersightDeviceConnectorConnection", "asset.ScopedTargetConnection", "asset.SshConnection" ], "x-enum-as-string": true }, "Credential": { "description": "The credential to be used to authenticate with the managed target.", "$ref": "#/components/schemas/asset.Credential", "x-omitempty": true } } } ] }, "asset.ConnectionFlapStatus": { "title": "Asset:Connection Flap Status", "description": "Encapsulates key details used to identify devices experiencing connection flapping.", "x-allOf-name": "asset.ConnectionFlapStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ConnectionFlapStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ConnectionFlapStatus" ], "default": "asset.ConnectionFlapStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ConnectionFlapStatus" ], "default": "asset.ConnectionFlapStatus", "x-enum-as-string": true }, "FlapAlertTime": { "description": "Time when flapping was reported.", "type": "string", "format": "date-time", "x-omitempty": true }, "FlapCount": { "description": "The number of times a device disconnected within a specified time window.", "type": "integer", "format": "int64", "x-omitempty": true }, "FlapDetected": { "description": "Indicates if the device is flapping.", "type": "boolean", "x-omitempty": true }, "WindowSize": { "description": "The time window during which device disconnects are counted. E.g. values are PT30M or PT1H.", "type": "string", "x-omitempty": true } } } ] }, "asset.ContractInformation": { "title": "Asset:Contract Information", "description": "Type for saving contract information.", "x-allOf-name": "asset.ContractInformation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ContractInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ContractInformation" ], "default": "asset.ContractInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ContractInformation" ], "default": "asset.ContractInformation", "x-enum-as-string": true }, "BillTo": { "description": "BillTo address of listed for the contract.", "$ref": "#/components/schemas/asset.AddressInformation", "readOnly": true, "x-omitempty": true }, "BillToGlobalUltimate": { "description": "BillToGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "readOnly": true, "x-omitempty": true }, "ContractNumber": { "description": "Contract number for the Cisco support contract purchased for the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "LineStatus": { "description": "Contract status as per the Cisco Contract APIx.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.Credential": { "title": "Asset:Credential", "description": "A credential which can be used to authenticate with a managed target.", "x-allOf-name": "asset.Credential", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "asset.CustomerInformation": { "title": "Asset:Customer Information", "description": "Type for saving contract information.", "x-allOf-name": "asset.CustomerInformation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.CustomerInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.CustomerInformation" ], "default": "asset.CustomerInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.CustomerInformation" ], "default": "asset.CustomerInformation", "x-enum-as-string": true }, "Address": { "description": "Address as per the information provided by the user.", "$ref": "#/components/schemas/asset.AddressInformation", "readOnly": true, "x-omitempty": true }, "Id": { "description": "Unique identifier for an end customer. This identifier is allocated by Cisco.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name as per the information provided by the user.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.Deployment.Response": { "description": "The response body of a HTTP GET request for the 'asset.Deployment' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.Deployment' resources.", "x-one-of-name": "asset.Deployment.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.Deployment.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.Deployment.Relationship": { "description": "A relationship to the 'asset.Deployment' resource, or the expanded 'asset.Deployment' resource, or the 'null' value.", "x-one-of-name": "asset.Deployment.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.Deployment" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.Deployment": { "title": "Asset:Deployment", "description": "The Deployment object is an essential element of the Cisco consumption-based subscription ecosystem, providing detailed information about deployments associated with subscriptions. It ensures seamless integration and updates through Cisco Install Base, supporting effective deployment tracking and management.\n#### Purpose\nDeployment serves as a detailed repository for tracking and managing deployments under consumption-based subscriptions, facilitating automated updates and ensuring accurate data representation. This information is also queried by downstream OPUS team for billing purposes. \n#### Key Concepts\n- **Integration:** Automates deployment management through synchronization with Cisco Install Base, ensuring data accuracy.\n- **Detailed Information:** Provides comprehensive data on deployment status, customer details, and associated metrics.\n- **Access Management:** Enforces secure access through defined privileges, ensuring only authorized users can interact with deployment data.\n- **Relationship and Dependency Handling:** Manages complex relationships between deployments, devices, and subscriptions, supporting efficient management.\n- **Consumption metering Alerts:** It keeps track of Deployment level consumption based metering related alerts.", "x-allOf-name": "asset.Deployment", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Deployment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.Deployment" ], "default": "asset.Deployment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.Deployment" ], "default": "asset.Deployment", "x-enum-as-string": true }, "AlarmInfo": { "description": "Different alarm types raised for the deployment.", "$ref": "#/components/schemas/asset.DeploymentAlarmInfo", "readOnly": true, "x-omitempty": true }, "DeploymentRefId": { "description": "Identifies the consumption-based subscription's deployment.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndCustomer": { "description": "End customer information for the purchased Cisco device's deployment.", "$ref": "#/components/schemas/asset.CustomerInformation", "readOnly": true, "x-omitempty": true }, "EndDate": { "description": "End Date for the consumption-based subscription's deployment.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LicenseType": { "description": "Active license tier for the purchased Cisco device's deployment.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "readOnly": true, "x-omitempty": true }, "MlbOfferType": { "description": "Identifier for consumption based pricing. MLB refers to MultiLine Bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "StartDate": { "description": "Start Date for the consumption-based subscription's deployment.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "SubscriptionRefId": { "description": "Identifies the consumption-based subscription.", "type": "string", "readOnly": true, "x-omitempty": true }, "UnitOfMeasure": { "type": "array", "items": { "description": "Unit of Measure identifies the type of metric being pushed. It is an array field. It contains \"vMemory\" for vm based metering, \"Storage\" for storage based metering and \"Node\" for Node based metering.", "$ref": "#/components/schemas/asset.MeteringType", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Workloads": { "type": "array", "items": { "description": "Workload/Usecase running on the deployment.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Devices": { "description": "An array of relationships to assetDeploymentDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeploymentDevice.Relationship" }, "nullable": true, "readOnly": true }, "Subscription": { "$ref": "#/components/schemas/asset.Subscription.Relationship", "description": "A reference to a assetSubscription resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.Deployment.List": { "title": "List of 'asset.Deployment' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.Deployment' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.Deployment' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.Deployment" }, "nullable": true } } } ] }, "asset.DeploymentAlarmInfo": { "title": "Asset:Deployment Alarm Info", "description": "Persists the different alarm type flags.", "x-allOf-name": "asset.DeploymentAlarmInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeploymentAlarmInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeploymentAlarmInfo" ], "default": "asset.DeploymentAlarmInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeploymentAlarmInfo" ], "default": "asset.DeploymentAlarmInfo", "x-enum-as-string": true }, "EnabledAlarms": { "type": "array", "items": { "description": "List of deployment related alarms raised.\n* `Unknown` - No specific alarms raised at this point of time.\n* `InvalidNodeLicense` - This deployment related alarm is raised when license tier on a deployment with node-metered servers is not Advantage+.\n* `InconsistentUnitOfMeasure` - This deployment related alarm is raised when devices of the same type within a deployment have different units of measure.\n* `InconsistentClusterUnitOfMeasure` - This deployment related alarm is raised when vm-metered servers forming an ESXi cluster have different units of measure.\n* `InvalidEsxiLicense` - This deployment related alarm is raised when license tier on a deployment with VM-metered servers is not Advantage+.\n* `VcenterNotClaimed` - This deployment related alarm is raised when vCenter associated with one or more deployments shows up as unclaimed.\n* `InvalidEsxiAccountLicense` - This deployment related alarm is raised when deployment contains connected VM-metered servers but accounts's license tier is not Advantage+.\n* `NonConsumptionESXiServerAssociated` - This deployment related alarm is raised when deployment contains non-consumption servers participate in an ESXi cluster.\n* `InvalidSubscriptionAssociated` - This deployment related alarm is raised when servers within an ESXi cluster are part of different subscriptions.\n* `InvalidDeploymentAssociated` - This deployment related alarm is raised when servers are not part of related deployments.\n* `VcenterNotPublishingStats` - This deployment related alarm is raised when vm/cluster stats are not recorded from ESXi clusters for over 24 hours.\n* `InvalidCpuOverCommitmentFactor` - This deployment related alarm is raised when configured CPU over-commitment is higher than 2:1 on an ESXi cluster.\n* `InvalidVirtualCpuRatio` - This deployment related alarm is raised when total vCPUs allocated to VMs is greater than 2x the pCPUs available to the ESXi cluster.\n* `HxNotClaimed` - This deployment related alarm is raised when HyperFlex cluster associated with one or more deployments shows up as unclaimed.\n* `HxNotPublishingStats` - This deployment related alarm is raised when used/total storage is not recorded from HyperFlex clusters for over 24 hours.\n* `IncorrectReplicationFactor` - This deployment related alarm is raised when replication/redundancy factor on an HyperFlex cluster is configured lower than 3 (non-edge) or 2 (edge).", "type": "string", "enum": [ "Unknown", "InvalidNodeLicense", "InconsistentUnitOfMeasure", "InconsistentClusterUnitOfMeasure", "InvalidEsxiLicense", "VcenterNotClaimed", "InvalidEsxiAccountLicense", "NonConsumptionESXiServerAssociated", "InvalidSubscriptionAssociated", "InvalidDeploymentAssociated", "VcenterNotPublishingStats", "InvalidCpuOverCommitmentFactor", "InvalidVirtualCpuRatio", "HxNotClaimed", "HxNotPublishingStats", "IncorrectReplicationFactor" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "asset.DeploymentDevice.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeploymentDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeploymentDevice' resources.", "x-one-of-name": "asset.DeploymentDevice.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeploymentDevice.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeploymentDevice.Relationship": { "description": "A relationship to the 'asset.DeploymentDevice' resource, or the expanded 'asset.DeploymentDevice' resource, or the 'null' value.", "x-one-of-name": "asset.DeploymentDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeploymentDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeploymentDevice": { "title": "Asset:Deployment Device", "description": "The DeploymentDevice object is pivotal in managing device information within consumption-based subscriptions. This provides a detailed view of device installation status, replacements, and transaction history, facilitating seamless management through Cisco Install Base integration.\n#### Purpose\nDeploymentDevice acts as a detailed repository for device-related data within deployments, ensuring accurate tracking under consumption-based subscriptions. This information is also queried by downstream OPUS team for billing purposes. \n#### Key Concepts\n- **Device Management:** Centralizes device data, supporting efficient tracking and management within deployments.\n- **Integration with Install Base:** Listens to messages from Cisco Install Base for automated data updates, ensuring accuracy.\n- **Access Management:** Enforces secure access through defined privileges, ensuring only authorized users can interact with DeploymentDevice data.\n- **Heartbeat generation:** Active DeploymentDevice records are used to publish hourly heartbeats to track device level subscription usage for billing purposes.\n- **Relationship Management:** Manages associations between devices and deployments, supporting effective data management.\n- **Consumption metering Alerts:** It keeps track of device level consumption based metering related alerts.", "x-allOf-name": "asset.DeploymentDevice", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeploymentDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeploymentDevice" ], "default": "asset.DeploymentDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeploymentDevice" ], "default": "asset.DeploymentDevice", "x-enum-as-string": true }, "AlarmInfo": { "description": "Different alarm types raised for the deployment.", "$ref": "#/components/schemas/asset.DeploymentDeviceAlarmInfo", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "Unique identifier of the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceInformation": { "description": "Detailed device information including installation status and customer address.", "$ref": "#/components/schemas/asset.DeploymentDeviceInformation", "readOnly": true, "x-omitempty": true }, "DevicePid": { "description": "Product identifier for the specified Cisco device. It is used to distinguish between HyperFlex and UCS devices.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceStatistics": { "description": "Device statistics for HyperFlex and UCS devices.", "$ref": "#/components/schemas/asset.DeviceStatistics", "readOnly": true, "x-omitempty": true }, "ProductSubgroup": { "description": "Product Subgroup type helps to determine if device subgroup within Product type has to be billed using consumption metering. example \"N9300 Series\" in Product type \"SWITCH\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductType": { "description": "Product type helps to determine if device has to be billed using consumption metering. example \"SERVER\".", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDeviceMoid": { "description": "String reference to the device connector.", "type": "string", "readOnly": true, "x-omitempty": true }, "UnitOfMeasure": { "type": "array", "items": { "description": "Unit of Measure identifies the type of metric being pushed. It is an array field. It contains \"vMemory\" for vm based metering, \"Storage\" for storage based metering and \"Node\" for Node based metering.", "$ref": "#/components/schemas/asset.MeteringType", "readOnly": true, "x-omitempty": true }, "nullable": true }, "VirtualizationPlatform": { "description": "Virtualization platform is used to identify the hypervisor type. example \"ESXi\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Workload": { "description": "Workload/Usecase running on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Deployment": { "$ref": "#/components/schemas/asset.Deployment.Relationship", "description": "A reference to a assetDeployment resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DeviceContractInformation": { "$ref": "#/components/schemas/asset.DeviceContractInformation.Relationship", "description": "A reference to a assetDeviceContractInformation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 }, "Subscription": { "$ref": "#/components/schemas/asset.Subscription.Relationship", "description": "A reference to a assetSubscription resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SubscriptionAccount": { "$ref": "#/components/schemas/asset.SubscriptionAccount.Relationship", "description": "A reference to a assetSubscriptionAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.DeploymentDevice.List": { "title": "List of 'asset.DeploymentDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeploymentDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeploymentDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeploymentDevice" }, "nullable": true } } } ] }, "asset.DeploymentDeviceAlarmInfo": { "title": "Asset:Deployment Device Alarm Info", "description": "Persists the different alarm type flags.", "x-allOf-name": "asset.DeploymentDeviceAlarmInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeploymentDeviceAlarmInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeploymentDeviceAlarmInfo" ], "default": "asset.DeploymentDeviceAlarmInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeploymentDeviceAlarmInfo" ], "default": "asset.DeploymentDeviceAlarmInfo", "x-enum-as-string": true }, "EnabledAlarms": { "type": "array", "items": { "description": "List of device related alarms raised.\n* `Unknown` - No specific alarms raised at this point of time.\n* `DeviceNotReachable` - This device related alarm is raised when the device is not connected to Intersight.\n* `DeviceNotClaimed` - This device related alarm is raised when the device is not claimed within Intersight.\n* `DeviceNotEsxiClusterMember` - This device related alarm is raised when the VM-metered server is not part of an ESXi cluster.\n* `InvalidMemoryMirroringFactor` - This device related alarm is raised when memory mirroring is enabled on a VM-metered server.\n* `InvalidUcsServerLicense` - This device related alarm is raised when a claimed UCS server is not associated with the deployment's license.\n* `DeviceNotPublishingPowerState` - This device related alarm is raised when power state from connected node-metered servers is absent or unknown for over 24 hours.", "type": "string", "enum": [ "Unknown", "DeviceNotReachable", "DeviceNotClaimed", "DeviceNotEsxiClusterMember", "InvalidMemoryMirroringFactor", "InvalidUcsServerLicense", "DeviceNotPublishingPowerState" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "asset.DeploymentDeviceInformation": { "title": "Asset:Deployment Device Information", "description": "Type for saving the device information reported by Cisco Install Base. It is used in asset.DeploymentDevice object to save the device information.", "x-allOf-name": "asset.DeploymentDeviceInformation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeploymentDeviceInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeploymentDeviceInformation" ], "default": "asset.DeploymentDeviceInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeploymentDeviceInformation" ], "default": "asset.DeploymentDeviceInformation", "x-enum-as-string": true }, "ApplicationName": { "description": "Application name reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Description of device reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceTransactions": { "type": "array", "items": { "description": "All the device transactions reported by Cisco Install Base.", "$ref": "#/components/schemas/asset.DeviceTransaction", "readOnly": true, "x-omitempty": true }, "nullable": true }, "InstanceId": { "description": "Instance number of the device. example \"917280220\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ItemType": { "description": "Item type flag. example ATO, Child, Standalone. ATO - refers to Cisco Block based major device. Child - refers to Child device part of an ATO block. Standalone - refers to a device that is managed and configured as an individual entity with limited capacity.", "type": "string", "readOnly": true, "x-omitempty": true }, "MlbProductId": { "description": "Identifier corresponding to MLB Product Name. MLB refers to MultiLine Bundle.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MlbProductName": { "description": "Product Name for the device. It is used to determine if the server is to be billed as a UCS compute device or a storage cluster. MLB refers to MultiLine Bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceId": { "description": "Unique identifier of old Cisco device. It is the device ID of old Cisco device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceStatusDescription": { "description": "Description of status of old Cisco device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceStatusId": { "description": "Status ID of old Cisco device, which got replaced by the new device.\n* `0` - A default value to catch cases where device status is not correctly detected.\n* `10000` - Device is installed successfully.\n* `1010041` - Device is currently in Return Material Authorization process.\n* `10005` - Device is replaced successfully with another device.\n* `10007` - Device is returned succcessfuly.\n* `10009` - Device is terminated at customer's end.", "type": "integer", "enum": [ 0, 10000, 1010041, 10005, 10007, 10009 ], "default": 0, "readOnly": true, "x-omitempty": true }, "OldInstanceId": { "description": "Instance number of the old device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.DeviceClaim.Relationship": { "description": "A relationship to the 'asset.DeviceClaim' resource, or the expanded 'asset.DeviceClaim' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceClaim.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceClaim" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceClaim": { "title": "Asset:Device Claim", "description": "DeviceClaim captures the intent to claim a device to an Intersight account. A device can be unclaimed by performing a DELETE on a DeviceClaim instance. When performing a claim, a secret passphrase must be obtained from the device connector UI/API by a sufficiently privileged user. The passphrase is timebound and proves that the user currently has privileged administrative access to the device being claimed.", "x-allOf-name": "asset.DeviceClaim", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceClaim', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceClaim" ], "default": "asset.DeviceClaim", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceClaim" ], "default": "asset.DeviceClaim", "x-enum-as-string": true }, "SecurityToken": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/SecurityTokens').", "type": "string", "x-createOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/DeviceIdentifiers').", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "Device": { "$ref": "#/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 }, "Reservation": { "$ref": "#/components/schemas/resource.Reservation.Relationship", "description": "A reference to a resourceReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "asset.DeviceConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeviceConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeviceConfiguration' resources.", "x-one-of-name": "asset.DeviceConfiguration.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeviceConfiguration.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeviceConfiguration.Relationship": { "description": "A relationship to the 'asset.DeviceConfiguration' resource, or the expanded 'asset.DeviceConfiguration' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceConfiguration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceConfiguration" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceConfiguration": { "title": "Asset:Device Configuration", "description": "The configuration of a device connector. Configuration properties may be changed by a Intersight user or by a device administrator using the connector's API exposed through the platforms management interface.", "x-allOf-name": "asset.DeviceConfiguration", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceConfiguration" ], "default": "asset.DeviceConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceConfiguration" ], "default": "asset.DeviceConfiguration", "x-enum-as-string": true }, "LocalConfigurationLocked": { "description": "Specifies whether configuration through the platforms local management interface has been disabled, with only configuration through the Intersight service enabled.", "type": "boolean", "x-omitempty": true }, "LogLevel": { "description": "The log level of the device connector service.", "type": "string", "x-omitempty": true }, "TunneledKvm": { "description": "Specifies whether Tunneled vKVM is enabled on the device connector.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Device": { "$ref": "#/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 } } } ] }, "asset.DeviceConfiguration.List": { "title": "List of 'asset.DeviceConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeviceConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeviceConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeviceConfiguration" }, "nullable": true } } } ] }, "asset.DeviceConnection.Relationship": { "description": "A relationship to the 'asset.DeviceConnection' resource, or the expanded 'asset.DeviceConnection' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceConnection.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceConnection" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceConnection": { "title": "Asset:Device Connection", "description": "An abstract class that holds the details of a device connectors connection to Intersight.", "x-allOf-name": "asset.DeviceConnection", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "asset.ClusterMember", "asset.DeviceRegistration" ], "x-enum-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": [ "asset.ClusterMember", "asset.DeviceRegistration" ], "x-enum-as-string": true }, "ApiVersion": { "description": "The version of the connector API, describes the capability of the connector's framework.\nIf the version is lower than the current minimum supported version defined in the service managing the connection, the device connector will be connected with limited capabilities until the device connector is upgraded to a fully supported version. For example if a device connector that was released without delta inventory capabilities registers and connects to Intersight, inventory collection may be disabled until it has been upgraded.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AppPartitionNumber": { "description": "The partition number corresponding to the instance of the Proxy App which is managing the web-socket to the device connector.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ConnectionId": { "description": "The unique identifier for the current connection. The identifier persists across network connectivity loss and is reset on device connector process restart or platform administrator toggle of the Intersight connectivity. The connectionId can be used by services that need to interact with stateful plugins running in the device connector process. For example if a service schedules an inventory in a devices job scheduler plugin at registration it is not necessary to reschedule the job if the device loses network connectivity due to an Intersight service upgrade or intermittent network issues in the devices datacenter.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionReason": { "description": "If 'connectionStatus' is not equal to Connected, connectionReason provides further details about why the device is not connected with Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "The status of the persistent connection between the device connector and Intersight.\n* `` - The target details have been persisted but Intersight has not yet attempted to connect to the target.\n* `Connected` - Intersight is able to establish a connection to the target and initiate management activities.\n* `NotConnected` - Intersight is unable to establish a connection to the target.\n* `ClaimInProgress` - Claim of the target is in progress. A connection to the target has not been fully established.\n* `UnclaimInProgress` - Unclaim of the target is in progress. Intersight is able to connect to the target and all management operations are supported.\n* `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. Also indicates the failure to claim Targets of type HTTP Endpoint in Intersight.\n* `Claimed` - Target of type HTTP Endpoint is successfully claimed in Intersight. Currently no validation is performed to verify the Target connectivity from Intersight at the time of creation. However invoking API from Intersight Orchestrator fails if this Target is not reachable from Intersight or if Target API credentials are incorrect.\n* `PreClaimed` - Target has been pre-claimed and is pending claim completion. Pre-claimed targets are pre-provisioned before endpoint is available to connect to Intersight, once target connects the claim can be completed by providing the security token to the pre-claim API.", "type": "string", "enum": [ "", "Connected", "NotConnected", "ClaimInProgress", "UnclaimInProgress", "Unclaimed", "Claimed", "PreClaimed" ], "default": "", "readOnly": true, "x-omitempty": true }, "ConnectionStatusLastChangeTime": { "description": "The last time at which the 'connectionStatus' property value changed. If connectionStatus is Connected, this time can be interpreted as the starting time since which a persistent connection has been maintained between Intersight and Device Connector. If connectionStatus is NotConnected, this time can be interpreted as the last time the device connector was connected with Intersight.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ConnectorVersion": { "description": "The version of the device connector running on the managed device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceExternalIpAddress": { "description": "The IP Address of the managed device as seen from Intersight at the time of registration.\nThis could be the IP address of the managed device's interface which has a route to the internet or a NAT IP address when the managed device is deployed in a private network.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProxyApp": { "description": "The name of the app which will proxy the messages to the device connector.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.DeviceConnectorManager.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeviceConnectorManager' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeviceConnectorManager' resources.", "x-one-of-name": "asset.DeviceConnectorManager.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeviceConnectorManager.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeviceConnectorManager": { "title": "Asset:Device Connector Manager", "description": "The DeviceConnectorManager object is a central component in managing registered Intersight Assist Appliance Devices within the Intersight ecosystem. This provides essential information and controls pertaining to device registration and management.\n #### Purpose\nDeviceConnectorManager is responsible for maintaining and overseeing the registration status of Intersight Assist appliances. It helps manage the lifecycle and connectivity of devices, ensuring they are effectively integrated and operational within the system.\n#### Key Concepts\n- **Device Registration:** Manages the registration of Intersight Assist appliances, ensuring they are correctly enrolled and identified within the system.\n- **Lifecycle Management:** Facilitates the management of the device lifecycle, including registration, updates, and potential deregistration.\n- **Relationship Management:** Establishes and maintains relationships with registered devices, supporting cascading updates and ensuring that connected systems are informed of changes.\n- **Access Control:** Utilizes privilege sets to control access and operations, ensuring that only authorized users can perform device management tasks.", "x-allOf-name": "asset.DeviceConnectorManager", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceConnectorManager', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceConnectorManager" ], "default": "asset.DeviceConnectorManager", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceConnectorManager" ], "default": "asset.DeviceConnectorManager", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "asset.DeviceConnectorManager.List": { "title": "List of 'asset.DeviceConnectorManager' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeviceConnectorManager' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeviceConnectorManager' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeviceConnectorManager" }, "nullable": true } } } ] }, "asset.DeviceContractInformation.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeviceContractInformation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeviceContractInformation' resources.", "x-one-of-name": "asset.DeviceContractInformation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeviceContractInformation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeviceContractInformation.Relationship": { "description": "A relationship to the 'asset.DeviceContractInformation' resource, or the expanded 'asset.DeviceContractInformation' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceContractInformation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceContractInformation" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceContractInformation": { "title": "Asset:Device Contract Information", "description": "The DeviceContractInformation object provides a comprehensive structure for managing contract-related information of Cisco devices identified by unique identifiers. It integrates data from Cisco APIs to ensure valid device status and contract details, supporting efficient device management.\n#### Purpose\nDeviceContractInformation serves as a central repository for viewing contract-related data of Cisco devices, facilitating efficient tracking and validation through Cisco API integration.\n#### Key Concepts\n- **Contract Management:** Provides detailed information on device contracts, supporting efficient tracking.\n- **Integration with Cisco APIs:** Ensures accurate and validated device information through periodic data synchronization.\n- **Access Control:** Enforces secure access through defined privileges, ensuring authorized interactions with contract data.\n- **Detailed Information:** Maintains comprehensive records of contract status, warranty details, and customer information, supporting reliable data management.", "x-allOf-name": "asset.DeviceContractInformation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceContractInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceContractInformation" ], "default": "asset.DeviceContractInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceContractInformation" ], "default": "asset.DeviceContractInformation", "x-enum-as-string": true }, "Contract": { "description": "Contract information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.ContractInformation", "readOnly": true, "x-omitempty": true }, "ContractStatus": { "description": "Calculated contract status that is derived based on the service line status and contract end date. It is different from serviceLineStatus property. serviceLineStatus gives us ACTIVE, OVERDUE, EXPIRED. These are transformed into Active, Expiring Soon and Not Covered.\n* `Unknown` - The device's contract status cannot be determined.\n* `Not Covered` - The Cisco device does not have a valid support contract.\n* `Active` - The Cisco device is covered under a active support contract.\n* `Expiring Soon` - The contract for this Cisco device is going to expire in the next 30 days.", "type": "string", "enum": [ "Unknown", "Not Covered", "Active", "Expiring Soon" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ContractStatusReason": { "description": "Reason for contract status. In case of Not Covered, reason is either Terminated or Expired.\n* `` - There is no reason for the specified contract status.\n* `Line Item Expired` - The Cisco device does not have a valid support contract, it has expired.\n* `Line Item Terminated` - The Cisco device does not have a valid support contract, it has been terminated.", "type": "string", "enum": [ "", "Line Item Expired", "Line Item Terminated" ], "default": "", "readOnly": true, "x-omitempty": true }, "ContractUnavailableRetryCount": { "description": "If Contract details doesn't exists in CCW API response, we will retry couple of times based on threshold value Retry count will track the number of retry happens due to contract details unavailability.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ContractUpdatedTime": { "description": "Date and time indicating when the contract data is last fetched from Cisco's Contract API successfully.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "CoveredProductLineEndDate": { "description": "End date of the covered product line. The coverage end date is fetched from Cisco SN2INFO API.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "Unique identifier of the Cisco device. This information is used to query Cisco APIx SN2INFO and CCWR databases.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceType": { "description": "Type used to classify the device in Cisco Intersight. Currently supported values are Server and FabricInterconnect. This will be expanded to support more types in future.\n* `None` - A default value to catch cases where device type is not correctly detected.\n* `CiscoUcsServer` - A device of type server. It includes Cisco IMC and UCS Managed servers.\n* `CiscoUcsFI` - A device of type Fabric Interconnect. It includes the various types of Cisco Fabric Interconnects supported by Cisco Intersight.\n* `CiscoUcsChassis` - A device of type Chassis. It includes various UCS chassis supported by Cisco Intersight.\n* `CiscoNexusSwitch` - A device of type Nexus switch. It includes various Nexus switches supported by Cisco Intersight.\n* `CiscoMDSSwitch` - A device of type MDS switch. It includes various MDS switches supported by Cisco Intersight.\n* `CiscoEdgeServer` - A device of type Edge Server. It includes various edge servers supported by Cisco Intersight.\n* `CiscoEdgeChassis` - A device of type Edge Chassis. It includes various edge chassis supported by Cisco Intersight.", "type": "string", "enum": [ "None", "CiscoUcsServer", "CiscoUcsFI", "CiscoUcsChassis", "CiscoNexusSwitch", "CiscoMDSSwitch", "CiscoEdgeServer", "CiscoEdgeChassis" ], "default": "None", "readOnly": true, "x-omitempty": true }, "EndCustomer": { "description": "End customer information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.CustomerInformation", "readOnly": true, "x-omitempty": true }, "EndUserGlobalUltimate": { "description": "EndUserGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "readOnly": true, "x-omitempty": true }, "IsValid": { "description": "Validates if the device is a genuine Cisco device. Validated is done using the Cisco SN2INFO APIs.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ItemType": { "description": "Item type of this specific Cisco device. example \"Chassis\".", "type": "string", "readOnly": true, "x-omitempty": true }, "LastDateOfSupport": { "description": "The last date of hardware support for this device.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "MaintenancePurchaseOrderNumber": { "description": "Maintenance purchase order number for the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "MaintenanceSalesOrderNumber": { "description": "Maintenance sales order number for the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformType": { "description": "The platform type of the Cisco device.\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 }, "Product": { "description": "Product information of the offering under a contract.", "$ref": "#/components/schemas/asset.ProductInformation", "readOnly": true, "x-omitempty": true }, "PurchaseOrderNumber": { "description": "Purchase order number for the Cisco device. It is a unique number assigned for every purchase.", "type": "string", "readOnly": true, "x-omitempty": true }, "ResellerGlobalUltimate": { "description": "ResellerGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "readOnly": true, "x-omitempty": true }, "SalesOrderNumber": { "description": "Sales order number for the Cisco device. It is a unique number assigned for every sale.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceDescription": { "description": "The type of service contract that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceEndDate": { "description": "End date for the Cisco service contract that covers this Cisco device.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ServiceLevel": { "description": "The type of service contract that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceSku": { "description": "The SKU of the service contract that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceStartDate": { "description": "Start date for the Cisco service contract that covers this Cisco device.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "StateContract": { "description": "Internal property used for triggering and tracking actions for contract information.\n* `Update` - Sn2Info/Contract information needs to be updated.\n* `OK` - Sn2Info/Contract information was fetched succcessfuly and updated.\n* `Failed` - Sn2Info/Contract information was not available or failed while fetching.\n* `Retry` - Sn2Info/Contract information update failed and will be retried later.\n* `Inactive` - Device is not in connected state (offline). No action will be taken when the state is Inactive.", "type": "string", "enum": [ "Update", "OK", "Failed", "Retry", "Inactive" ], "default": "Update", "x-omitempty": true }, "WarrantyEndDate": { "description": "End date for the warranty that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "WarrantyType": { "description": "Type of warranty that covers the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 }, "Source": { "$ref": "#/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 } } } ] }, "asset.DeviceContractInformation.List": { "title": "List of 'asset.DeviceContractInformation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeviceContractInformation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeviceContractInformation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeviceContractInformation" }, "nullable": true } } } ] }, "asset.DeviceContractNotification": { "title": "Asset:Device Contract Notification", "description": "The DeviceContractNotification object facilitates communication between appliances and cloud systems, supporting contract status computations. It acts as an intermediary for sending and receiving contract status data, ensuring seamless integration and updates.\n#### Purpose\nDeviceContractNotification serves as a communication bridge between appliances and cloud systems, supporting efficient contract status management and updates.\n#### Key Concepts\n- **Communication Management:** Facilitates data exchange between appliances and cloud systems for contract status computations.\n- **Integration:** Supports seamless integration with Cisco systems for accurate and timely contract status updates.\n- **Access Management:** Ensures secure handling of contract data through defined privileges and permissions.\n- **Data Persistence:** Maintains reliable data exchange for contract status management, supporting consistent updates.", "x-allOf-name": "asset.DeviceContractNotification", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceContractNotification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceContractNotification" ], "default": "asset.DeviceContractNotification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceContractNotification" ], "default": "asset.DeviceContractNotification", "x-enum-as-string": true }, "Contract": { "description": "Contract information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.ContractInformation", "x-omitempty": true }, "ContractStatus": { "description": "Calculated contract status that is derived based on the service line status and contract end date. It is different from serviceLineStatus property. serviceLineStatus gives us ACTIVE, OVERDUE, EXPIRED. These are transformed into Active, Expiring Soon and Not Covered.\n* `Unknown` - The device's contract status cannot be determined.\n* `Not Covered` - The Cisco device does not have a valid support contract.\n* `Active` - The Cisco device is covered under a active support contract.\n* `Expiring Soon` - The contract for this Cisco device is going to expire in the next 30 days.", "type": "string", "enum": [ "Unknown", "Not Covered", "Active", "Expiring Soon" ], "default": "Unknown", "x-omitempty": true }, "ContractStatusReason": { "description": "Reason for contract status. In case of Not Covered, reason is either Terminated or Expired.\n* `` - There is no reason for the specified contract status.\n* `Line Item Expired` - The Cisco device does not have a valid support contract, it has expired.\n* `Line Item Terminated` - The Cisco device does not have a valid support contract, it has been terminated.", "type": "string", "enum": [ "", "Line Item Expired", "Line Item Terminated" ], "default": "", "x-omitempty": true }, "ContractUpdatedTime": { "description": "Date and time indicating when the contract data is last refreshed.", "type": "string", "format": "date-time", "x-omitempty": true }, "CoveredProductLineEndDate": { "description": "End date of the covered product line. The coverage end date is fetched from Cisco SN2INFO API.", "type": "string", "x-omitempty": true }, "DeviceId": { "description": "Unique identifier of the Cisco device.", "type": "string", "x-omitempty": true }, "EndCustomer": { "description": "End customer information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.CustomerInformation", "x-omitempty": true }, "EndUserGlobalUltimate": { "description": "EndUserGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "x-omitempty": true }, "IsValid": { "description": "Validates if the device is a genuine Cisco device. Validated is done using the Cisco SN2INFO APIs.", "type": "boolean", "x-omitempty": true }, "ItemType": { "description": "Item type of this specific Cisco device. example \"Chassis\".", "type": "string", "x-omitempty": true }, "LastDateOfSupport": { "description": "The last date of hardware support for this device.", "type": "string", "format": "date-time", "x-omitempty": true }, "MaintenancePurchaseOrderNumber": { "description": "Maintenance purchase order number for the Cisco device.", "type": "string", "x-omitempty": true }, "MaintenanceSalesOrderNumber": { "description": "Maintenance sales order number for the Cisco device.", "type": "string", "x-omitempty": true }, "Product": { "description": "Product information of the offering under a contract.", "$ref": "#/components/schemas/asset.ProductInformation", "x-omitempty": true }, "PurchaseOrderNumber": { "description": "Purchase order number for the Cisco device. It is a unique number assigned for every purchase.", "type": "string", "x-omitempty": true }, "ResellerGlobalUltimate": { "description": "ResellerGlobalUltimate information listed in the contract.", "$ref": "#/components/schemas/asset.GlobalUltimate", "x-omitempty": true }, "SalesOrderNumber": { "description": "Sales order number for the Cisco device. It is a unique number assigned for every sale.", "type": "string", "x-omitempty": true }, "ServiceDescription": { "description": "The type of service contract that covers the Cisco device.", "type": "string", "x-omitempty": true }, "ServiceEndDate": { "description": "End date for the Cisco service contract that covers this Cisco device.", "type": "string", "format": "date-time", "x-omitempty": true }, "ServiceLevel": { "description": "The type of service contract that covers the Cisco device.", "type": "string", "x-omitempty": true }, "ServiceSku": { "description": "The SKU of the service contract that covers the Cisco device.", "type": "string", "x-omitempty": true }, "ServiceStartDate": { "description": "Start date for the Cisco service contract that covers this Cisco device.", "type": "string", "format": "date-time", "x-omitempty": true }, "StateContract": { "description": "Internal property used for triggering and tracking actions for contract information.\n* `Update` - Sn2Info/Contract information needs to be updated.\n* `OK` - Sn2Info/Contract information was fetched succcessfuly and updated.\n* `Failed` - Sn2Info/Contract information was not available or failed while fetching.\n* `Retry` - Sn2Info/Contract information update failed and will be retried later.\n* `Inactive` - Device is not in connected state (offline). No action will be taken when the state is Inactive.", "type": "string", "enum": [ "Update", "OK", "Failed", "Retry", "Inactive" ], "default": "Update", "x-omitempty": true }, "StateSn2Info": { "description": "Internal property used for triggering and tracking actions for sn2info information.\n* `Update` - Sn2Info/Contract information needs to be updated.\n* `OK` - Sn2Info/Contract information was fetched succcessfuly and updated.\n* `Failed` - Sn2Info/Contract information was not available or failed while fetching.\n* `Retry` - Sn2Info/Contract information update failed and will be retried later.\n* `Inactive` - Device is not in connected state (offline). No action will be taken when the state is Inactive.", "type": "string", "enum": [ "Update", "OK", "Failed", "Retry", "Inactive" ], "default": "Update", "x-omitempty": true }, "WarrantyEndDate": { "description": "End date for the warranty that covers the Cisco device.", "type": "string", "x-omitempty": true }, "WarrantyType": { "description": "Type of warranty that covers the Cisco device.", "type": "string", "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "asset.DeviceEndpointLocalCredential": { "title": "Asset:Device Endpoint Local Credential", "description": "Used against a device endpoint that manages its own local credential.", "x-allOf-name": "asset.DeviceEndpointLocalCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" } ] }, "asset.DeviceInformation": { "title": "Asset:Device Information", "description": "Type for saving the device information reported by Cisco Install Base. It is used in asset.SubscriptionDeviceInformation object to save the device information.", "x-allOf-name": "asset.DeviceInformation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceInformation" ], "default": "asset.DeviceInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceInformation" ], "default": "asset.DeviceInformation", "x-enum-as-string": true }, "ApplicationName": { "description": "Application name reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceTransactions": { "type": "array", "items": { "description": "All the device transactions reported by Cisco Install Base.", "$ref": "#/components/schemas/asset.DeviceTransaction", "readOnly": true, "x-omitempty": true }, "nullable": true }, "EndCustomer": { "description": "End customer information for the Cisco support contract purchased for the Cisco device.", "$ref": "#/components/schemas/asset.CustomerInformation", "readOnly": true, "x-omitempty": true }, "InstanceId": { "description": "Instance number of the device. example \"917280220\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ItemType": { "description": "Item type flag. example ATO, Child, Standalone. ATO - refers to Cisco Block based major device. Child - refers to Child device part of an ATO block. Standalone - refers to a device that is managed and configured as an individual entity with limited capacity.", "type": "string", "readOnly": true, "x-omitempty": true }, "MlbOfferType": { "description": "Identifier for consumption based pricing. MLB refers to MultiLine Bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "MlbProductId": { "description": "Identifier corresponding to MLB Product Name. MLB refers to MultiLine Bundle.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MlbProductName": { "description": "Product Name for the device. It is used to determine if the server is to be billed as a UCS compute device or a storage cluster. MLB refers to MultiLine Bundle.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceId": { "description": "Unique identifier of old Cisco device. It is the device ID of old Cisco device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceStatusDescription": { "description": "Description of status of old Cisco device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "OldDeviceStatusId": { "description": "Status ID of old Cisco device, which got replaced by the new device.\n* `0` - A default value to catch cases where device status is not correctly detected.\n* `10000` - Device is installed successfully.\n* `1010041` - Device is currently in Return Material Authorization process.\n* `10005` - Device is replaced successfully with another device.\n* `10007` - Device is returned succcessfuly.\n* `10009` - Device is terminated at customer's end.", "type": "integer", "enum": [ 0, 10000, 1010041, 10005, 10007, 10009 ], "default": 0, "readOnly": true, "x-omitempty": true }, "OldInstanceId": { "description": "Instance number of the old device, which got replaced by the new device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductFamily": { "description": "Product Family is the field used to identify the hypervisor type. example \"ESXi\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductType": { "description": "Product type helps to determine if device has to be billed using consumption metering. example \"SERVER\".", "type": "string", "readOnly": true, "x-omitempty": true }, "UnitOfMeasure": { "description": "Unit of Measure is flag used to identify the type of metric being pushed. example - \"STORAGE\" for hardware metrics , \"VM\" - for hypervisor metrics.\n* `None` - A default value to catch cases where unit of measure is not correctly detected.\n* `STORAGE` - The metric type of the device is a storage metric.\n* `NODE` - The metric type of the device is a hardware metric.\n* `VM` - The metric type of the device is a hypervisor metric.", "type": "string", "enum": [ "None", "STORAGE", "NODE", "VM" ], "default": "None", "readOnly": true, "x-omitempty": true } } } ] }, "asset.DeviceRegistration.Response": { "description": "The response body of a HTTP GET request for the 'asset.DeviceRegistration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.DeviceRegistration' resources.", "x-one-of-name": "asset.DeviceRegistration.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.DeviceRegistration.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.DeviceRegistration.Relationship": { "description": "A relationship to the 'asset.DeviceRegistration' resource, or the expanded 'asset.DeviceRegistration' resource, or the 'null' value.", "x-one-of-name": "asset.DeviceRegistration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.DeviceRegistration" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.DeviceRegistration": { "title": "Asset:Device Registration", "description": "The DeviceRegistration object represents a device connector-enabled endpoint that has registered with Intersight. It is a concrete object central to the management of devices, allowing them to be claimed, configured, and monitored within Intersight's infrastructure.\n#### Purpose\nThe DeviceRegistration serves as the primary interface for representing devices within Intersight. It facilitates device management, enabling users to perform operations like claiming, updating, or deleting device-related data. It is essential for capturing the status and configuration of devices interacting with Intersight services.\n#### Key Concepts\n- **Claiming and Ownership:** Supports claiming devices into a user's account, establishing ownership and enabling management operations.\n- **Connectivity Status:** Provides insights into the device's connection status with Intersight, including persistent connection details.\n- **Device Identity:** Maintains device-specific information, such as serial numbers and product IDs, crucial for device validation and tracking.\n- **Security and Access:** Ensures secure management through authentication keys and tokens, facilitating safe device operation and interaction with Intersight.", "x-allOf-name": "asset.DeviceRegistration", "allOf": [ { "$ref": "#/components/schemas/asset.DeviceConnection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceRegistration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceRegistration" ], "default": "asset.DeviceRegistration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceRegistration" ], "default": "asset.DeviceRegistration", "x-enum-as-string": true }, "AccessKeyId": { "description": "An identifier for the credential used by the device connector to authenticate with the Intersight web socket gateway.", "type": "string", "x-omitempty": true }, "ClaimedByUserName": { "description": "The name of the user who claimed the device for the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClaimedTime": { "description": "The date and time at which the device was claimed to this account.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "DeviceHostname": { "type": "array", "items": { "description": "The hostnames of the managed device. There can be multiple hostnames depending on the number of elements managed (i.e. HA clusters).", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DeviceIpAddress": { "type": "array", "items": { "description": "The IP Addresses of the managed device. There can be multiple management IPs depending on the number of elements managed (i.e. HA clusters) and in-band/out-of-band connectivity.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExecutionMode": { "description": "Indicates if the platform is an actual device or an emulated device for testing, demos, etc. Permitted values are [Normal, Emulator, ContainerEmulator].\n* `` - The device reported an empty or unrecognized executionMode.\n* `Normal` - The device connector is running in normal mode, i.e. it is not a simulation.\n* `Emulator` - The device connector is running in simulation mode inside an emulated device.\n* `ContainerEmulator` - The device connector is running in simulation mode inside a containerized emulated device.", "type": "string", "enum": [ "", "Normal", "Emulator", "ContainerEmulator" ], "default": "", "x-createOnly": true, "x-omitempty": true }, "ParentSignature": { "description": "A signature generated by a parent device or target used to auto-claim a device into a user account at time of registration.", "$ref": "#/components/schemas/asset.ClaimSignature", "x-createOnly": true, "x-omitempty": true }, "Pid": { "type": "array", "items": { "description": "The product Id of the managed device.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PlatformType": { "description": "The platform type on which device connector is executing.\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-createOnly": true, "x-omitempty": true }, "PublicAccessKey": { "description": "The device connector's public key used by Intersight to authenticate a connection from the device connector. The public key is used to verify that the signature a device connector sends on connect has been signed by the connector's private key stored on the device's filesystem. Must be a PEM encoded RSA or Ed22519 public key string.", "type": "string", "readOnly": true, "x-omitempty": true }, "PublicAccessKeyRotated": { "description": "The device connectors rotated public key. The device connector may rotate its key pair in conditions where it has been determined the key may have been compromised or if the key type is changing (e.g. moving from RSA to elliptical curve). The device connector will rotate its key in a two step process in order to ensure Intersight has received and committed the new key before invalidating the previous. Device connectors will first send the new public key on PublicAccessKeyRotated, the public key string will also be signed by the current private key. On receipt of a 200 response from Intersight the device connector commits the new key to its local database and will use it for all future authentication requests. Intersight will then allow both the previous and rotated key periods until the device connects with the rotated key, at which point the previous key is invalidated and removed.", "type": "string", "readOnly": true, "x-omitempty": true }, "PublicEncryptionKey": { "description": "The device connector public key used by Intersight for encryption. The public key is used to encrypt ephemeral aes keys to be used for decrypting sensitive data from Intersight. Must be a PEM encoded RSA public key string.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReadOnly": { "description": "Flag reported by devices to indicate an administrator of the device has disabled management operations of the device connector and only monitoring is permitted.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "RotateAccessKey": { "description": "Request the device to rotate its key pair. SRE team may set this field to trigger the device to rotate its key pair in conditions where it has been identified that the device's key has been compromised. When RotateAccessKey is set to true the device will be forced to re-connect and rotate its key.", "type": "boolean", "x-omitempty": true }, "Serial": { "type": "array", "items": { "description": "A list of serial numbers of the individual device elements (e.g. HA primary/secondary or cluster members) which are exposed as a single unit of management by the device connector.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Vendor": { "description": "The vendor of the managed device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "ClaimedByUser": { "$ref": "#/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 }, "ClusterMembers": { "description": "An array of relationships to assetClusterMember resources.", "type": "array", "items": { "$ref": "#/components/schemas/asset.ClusterMember.Relationship" }, "nullable": true, "readOnly": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "DeviceClaim": { "$ref": "#/components/schemas/asset.DeviceClaim.Relationship", "description": "A reference to a assetDeviceClaim resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DeviceConfiguration": { "$ref": "#/components/schemas/asset.DeviceConfiguration.Relationship", "description": "A reference to a assetDeviceConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DomainGroup": { "$ref": "#/components/schemas/iam.DomainGroup.Relationship", "description": "A reference to a iamDomainGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ParentConnection": { "$ref": "#/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 }, "Target": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.DeviceRegistration.List": { "title": "List of 'asset.DeviceRegistration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.DeviceRegistration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.DeviceRegistration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.DeviceRegistration" }, "nullable": true } } } ] }, "asset.DeviceStatistics": { "title": "Asset:Device Statistics", "description": "Type for saving device statistics related information for HyperFlex and UCS devices. It is used in asset.DeploymentDevice object to save the current device statistics.", "x-allOf-name": "asset.DeviceStatistics", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceStatistics', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceStatistics" ], "default": "asset.DeviceStatistics", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceStatistics" ], "default": "asset.DeviceStatistics", "x-enum-as-string": true }, "ClusterDeploymentType": { "description": "Deployment type of HyperFlex cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterDeviceMoid": { "description": "Reference to HyperFlex cluster target device ID.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterName": { "description": "Name of the cluster. It is specified only for HyperFlex based devices.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterReplicationFactor": { "description": "Data replication factor of HyperFlex cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Connected": { "description": "The status of the persistent connection between the device connector and Intersight, for HyperFlex or UCS device. 1 represents being connected and 0 represents being disconnected.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MembershipRatio": { "description": "Defines the average proportion of resources used by the device within the cluster. example in a cluster having 3 nodes, the membershipRatio of each node is 1/3 or 0.33. It is specified only for HyperFlex based devices.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "MemoryMirroringFactor": { "description": "Memory Reliability, availability and serviceability (RAS) factor.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "VmHost": { "description": "VM host which is associated with the serial. It is updated only for devices which has vm installation.", "$ref": "#/components/schemas/asset.VmHost", "readOnly": true, "x-omitempty": true } } } ] }, "asset.DeviceTransaction": { "title": "Asset:Device Transaction", "description": "Type for saving the device transaction history. It is used in asset.DeploymentDeviceInformation object to save the device transactions.", "x-allOf-name": "asset.DeviceTransaction", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.DeviceTransaction', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.DeviceTransaction" ], "default": "asset.DeviceTransaction", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.DeviceTransaction" ], "default": "asset.DeviceTransaction", "x-enum-as-string": true }, "Action": { "description": "The action taken by Cisco Install Base on the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusDescription": { "description": "Description of status of Cisco device reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusId": { "description": "Status ID of device reported by Cisco Install Base.\n* `0` - A default value to catch cases where device status is not correctly detected.\n* `10000` - Device is installed successfully.\n* `1010041` - Device is currently in Return Material Authorization process.\n* `10005` - Device is replaced successfully with another device.\n* `10007` - Device is returned succcessfuly.\n* `10009` - Device is terminated at customer's end.", "type": "integer", "enum": [ 0, 10000, 1010041, 10005, 10007, 10009 ], "default": 0, "readOnly": true, "x-omitempty": true }, "Timestamp": { "description": "Timestamp field reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "TransactionBatchId": { "description": "Transaction batch ID reported by Cisco Install Base.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TransactionDate": { "description": "Transaction Date reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "TransactionSequence": { "description": "Transaction sequence reported by Cisco Install Base.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "asset.GenericTargetClaimOptions": { "title": "Asset:Generic Target Claim Options", "description": "Captures the generic set of options required to claim a generic target managed via assist. Should be used only by partners who are developing their integration using the Partner Integration appliance.", "x-allOf-name": "asset.GenericTargetClaimOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.GenericTargetClaimOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.GenericTargetClaimOptions" ], "default": "asset.GenericTargetClaimOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.GenericTargetClaimOptions" ], "default": "asset.GenericTargetClaimOptions", "x-enum-as-string": true }, "TargetOptions": { "description": "The generic device connector will consume these options.", "nullable": true, "x-omitempty": true } } } ] }, "asset.GeoLocation.Response": { "description": "The response body of a HTTP GET request for the 'asset.GeoLocation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.GeoLocation' resources.", "x-one-of-name": "asset.GeoLocation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.GeoLocation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.GeoLocation.Relationship": { "description": "A relationship to the 'asset.GeoLocation' resource, or the expanded 'asset.GeoLocation' resource, or the 'null' value.", "x-one-of-name": "asset.GeoLocation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.GeoLocation" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.GeoLocation": { "title": "Asset:Geo Location", "description": "The geographic location of a managed target.", "x-allOf-name": "asset.GeoLocation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.GeoLocation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.GeoLocation" ], "default": "asset.GeoLocation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.GeoLocation" ], "default": "asset.GeoLocation", "x-enum-as-string": true }, "Address": { "description": "The location's street address.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.PhysicalAddress", "x-omitempty": true }, "Coordinates": { "description": "The location's longitude and latitude coordinates.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.GeoPoint", "x-omitempty": true }, "Name": { "description": "A user provided name for the location.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "asset.GeoLocation.List": { "title": "List of 'asset.GeoLocation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.GeoLocation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.GeoLocation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.GeoLocation" }, "nullable": true } } } ] }, "asset.GlobalUltimate": { "title": "Asset:Global Ultimate", "description": "Type for customer information of the BillToGlobal.", "x-allOf-name": "asset.GlobalUltimate", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.GlobalUltimate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.GlobalUltimate" ], "default": "asset.GlobalUltimate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.GlobalUltimate" ], "default": "asset.GlobalUltimate", "x-enum-as-string": true }, "Id": { "description": "ID of the user in BillToGlobal.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the user in BillToGlobal.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.GoogleCloudPlatformServiceAccountKeyCredential": { "title": "Asset:Google Cloud Platform Service Account Key Credential", "description": "Google APIs use the OAuth 2.0 protocol for authentication and authorization. Google Cloud Platform (GCP) service account's key JSON file to get an access token to call Google APIs. Documentation : [link](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).", "x-allOf-name": "asset.GoogleCloudPlatformServiceAccountKeyCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.GoogleCloudPlatformServiceAccountKeyCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.GoogleCloudPlatformServiceAccountKeyCredential" ], "default": "asset.GoogleCloudPlatformServiceAccountKeyCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.GoogleCloudPlatformServiceAccountKeyCredential" ], "default": "asset.GoogleCloudPlatformServiceAccountKeyCredential", "x-enum-as-string": true }, "IsServiceAccountKeySet": { "description": "Indicates whether the value of the 'serviceAccountKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "KeyType": { "description": "Google Cloud Platform (GCP) service account's key type.\n* `JSON` - JavaScript Object Notation (JSON) is a standard text-based format for representing structured data based on JavaScript object syntax. It is commonly used for transmitting data in web applications.\n* `P12` - PKCS #12 is an archive file format for storing many cryptography objects as a single file. It is commonly used to bundle a private key with its X.509 certificate or to bundle all the members of a chain of trust.", "type": "string", "enum": [ "JSON", "P12" ], "default": "JSON", "x-omitempty": true }, "ServiceAccountKey": { "description": "Google Cloud Platform (GCP) service account's key file content in the format of the keyType specified.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "asset.HttpConnection": { "title": "Asset:Http Connection", "description": "HttpConnection provides the necessary details for Intersight to connect to and authenticate with a managed target over an HTTP connection.", "x-allOf-name": "asset.HttpConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.HttpConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.HttpConnection" ], "default": "asset.HttpConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.HttpConnection" ], "default": "asset.HttpConnection", "x-enum-as-string": true }, "CertificateAuthority": { "description": "The certificate authority of the target. If set and connection is secure the connection will be validate using the servers identity with this certificate. If not set no validation will be done of the identity.", "type": "string", "x-omitempty": true }, "IsSecure": { "description": "Indicates whether a connection to the target should be established using HTTPS.", "type": "boolean", "default": true, "x-omitempty": true }, "ManagementAddress": { "description": "The DNS hostname or IP Address, either IPv4 or IPv6, to be used to connect to the managed target.", "type": "string", "x-omitempty": true }, "Port": { "description": "The port number to be used to connect to the managed target. Values 1-65535 indicate a port number to be used. A value of 0 is not a valid port number and instead indicates that the default management port, as defined by the documentation of the managed target, should be used to establish a connection.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 65535, "x-omitempty": true } } } ] }, "asset.IntersightDeviceConnectorConnection": { "title": "Asset:Intersight Device Connector Connection", "description": "Target is connected to Intersight using a Device Connector.", "x-allOf-name": "asset.IntersightDeviceConnectorConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.IntersightDeviceConnectorConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.IntersightDeviceConnectorConnection" ], "default": "asset.IntersightDeviceConnectorConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.IntersightDeviceConnectorConnection" ], "default": "asset.IntersightDeviceConnectorConnection", "x-enum-as-string": true }, "PreClaim": { "description": "A pre-claim of an embedded target. Does not require a security token to be provided at target create, target will be created in a pre-claim state.", "type": "boolean", "writeOnly": true, "x-omitempty": true }, "SecurityToken": { "description": "The SecurityToken object holds a time-limited random string used for claiming a device. It is created implicitly for each device connector at the time of registration, providing a secure mechanism for users to assert administrative access during device claim operations.\n#### Purpose\nSecurityToken acts as a temporary credential that proves a user's administrative access to a device, allowing them to claim the device within Intersight. It strengthens the security of claim operations, preventing unauthorized device claims by restricting access to users who possess the token.\n#### Key Concepts\n- **Time-Bound Security:** Tokens are generated with expiration times, ensuring they are only valid for a limited duration to reduce the risk of misuse.\n- **Claim Validation:** Used during claim operations to validate that the user has the necessary privileges to manage the device.\n- **Access Control:** Integrates with Intersight's security model, providing controlled access to device claim functionalities.", "type": "string", "writeOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/DeviceIdentifiers').", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "asset.MerakiCloudOptions": { "title": "Asset:Meraki Cloud Options", "description": "Captures the Meraki organization Id that is mapped to the claimed target.", "x-allOf-name": "asset.MerakiCloudOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.MerakiCloudOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.MerakiCloudOptions" ], "default": "asset.MerakiCloudOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.MerakiCloudOptions" ], "default": "asset.MerakiCloudOptions", "x-enum-as-string": true }, "OrganizationId": { "description": "The Meraki organization id that is mapped to the target being claimed.", "type": "string", "x-omitempty": true } } } ] }, "asset.MeteringType": { "title": "Asset:Metering Type", "description": "Type for saving Metering details.", "x-allOf-name": "asset.MeteringType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.MeteringType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.MeteringType" ], "default": "asset.MeteringType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.MeteringType" ], "default": "asset.MeteringType", "x-enum-as-string": true }, "Name": { "description": "Metric type used to calculate metering for the device sent from the IB Contract. example Node, vMemory, vCPU.\n* `None` - A default value to catch cases where metric type is not correctly detected.\n* `Node` - The metering of the device is on the basis of Power state.\n* `Storage` - The metering of the device is on the basis of used Storage.\n* `vMemory` - The metering of the device is on the basis of VM Memory.\n* `vCPU` - The metering of the device is on the basis of vCPU.\n* `vStorage` - The metering of the device is on the basis of used virtual Storage.\n* `Switch` - The metering of the device is on the basis of Switch.", "type": "string", "enum": [ "None", "Node", "Storage", "vMemory", "vCPU", "vStorage", "Switch" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Unit": { "description": "Metric unit used to calculate metering for the device sent from the IB Contract. example Node, GiB, Cores.\n* `None` - A default value to catch cases where metric unit is not correctly detected.\n* `Node` - It is applicable for Node Metric type.\n* `GiB` - It is applicable for VMemory, vStorage and Storage Metric types.\n* `TiB` - It is applicable for VMemory, vStorage and Storage Metric types.\n* `Cores` - It is applicable for vCPU Metric type.\n* `Switch` - It is applicable for Switch Metric type.\n* `Port` - It is applicable for Switch Metric type.", "type": "string", "enum": [ "None", "Node", "GiB", "TiB", "Cores", "Switch", "Port" ], "default": "None", "readOnly": true, "x-omitempty": true } } } ] }, "asset.NewRelicCredential": { "title": "Asset:New Relic Credential", "description": "Credentials for authenticating with a NewRelic target. Management of a NewRelic target leverages multiple management interfaces and this credential object contains all necessary credentials.", "x-allOf-name": "asset.NewRelicCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.NewRelicCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.NewRelicCredential" ], "default": "asset.NewRelicCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.NewRelicCredential" ], "default": "asset.NewRelicCredential", "x-enum-as-string": true }, "GraphQlCredential": { "description": "A credential for authenticating with the NewRelic GraphQL interface.", "$ref": "#/components/schemas/asset.ApiKeyCredential", "x-omitempty": true }, "RestApiCredential": { "description": "A credential for authenticating with the NewRelic Rest API interface.", "$ref": "#/components/schemas/asset.ApiKeyCredential", "x-omitempty": true } } } ] }, "asset.NoAuthenticationCredential": { "title": "Asset:No Authentication Credential", "description": "Used against a target which does not require any credential.", "x-allOf-name": "asset.NoAuthenticationCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" } ] }, "asset.OauthBearerTokenCredential": { "title": "Asset:Oauth Bearer Token Credential", "description": "A credential which performs authentication based on a bearer token.", "x-allOf-name": "asset.OauthBearerTokenCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OauthBearerTokenCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OauthBearerTokenCredential" ], "default": "asset.OauthBearerTokenCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OauthBearerTokenCredential" ], "default": "asset.OauthBearerTokenCredential", "x-enum-as-string": true }, "IsTokenSet": { "description": "Indicates whether the value of the 'token' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "ScopeType": { "description": "Scope type for the crendetial i.e. User, Organization, Team.", "type": "string", "x-omitempty": true }, "ScopeValue": { "description": "Scope value for the credential i.e. username, organization name or team name.", "type": "string", "x-omitempty": true }, "Token": { "description": "The token used to authenticate with a managed target.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "asset.OauthClientIdSecretCredential": { "title": "Asset:Oauth Client Id Secret Credential", "description": "An OAuth credential which performs authentication based on a client ID and client Secret.", "x-allOf-name": "asset.OauthClientIdSecretCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OauthClientIdSecretCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OauthClientIdSecretCredential" ], "default": "asset.OauthClientIdSecretCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OauthClientIdSecretCredential" ], "default": "asset.OauthClientIdSecretCredential", "x-enum-as-string": true }, "ClientId": { "description": "The client ID used to authenticate with a managed target.", "type": "string", "x-omitempty": true }, "ClientSecret": { "description": "The client secret used to authenticate with a managed target.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsClientSecretSet": { "description": "Indicates whether the value of the 'clientSecret' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.OrchestrationCivpVmwareVcenterOptions": { "title": "Asset:Orchestration Civp Vmware Vcenter Options", "description": "Captures configuration specific to the VMware Vcenter target for the VSphere Remote Plugin.", "x-allOf-name": "asset.OrchestrationCivpVmwareVcenterOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OrchestrationCivpVmwareVcenterOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OrchestrationCivpVmwareVcenterOptions" ], "default": "asset.OrchestrationCivpVmwareVcenterOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OrchestrationCivpVmwareVcenterOptions" ], "default": "asset.OrchestrationCivpVmwareVcenterOptions", "x-enum-as-string": true }, "CivpEnabled": { "description": "CivpEnabled controls whether VSphere Remote Plugin is enabled or not. vCenter Server version 8.0 or later.", "type": "boolean", "x-omitempty": true }, "IsClientSecretSet": { "description": "Indicates whether the value of the 'clientSecret' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.OrchestrationHitachiVirtualStoragePlatformOptions": { "title": "Asset:Orchestration Hitachi Virtual Storage Platform Options", "description": "Captures configuration specific to the Hitachi Virtual Storage Platform target for the Orchestration service.", "x-allOf-name": "asset.OrchestrationHitachiVirtualStoragePlatformOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OrchestrationHitachiVirtualStoragePlatformOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OrchestrationHitachiVirtualStoragePlatformOptions" ], "default": "asset.OrchestrationHitachiVirtualStoragePlatformOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OrchestrationHitachiVirtualStoragePlatformOptions" ], "default": "asset.OrchestrationHitachiVirtualStoragePlatformOptions", "x-enum-as-string": true }, "OpsCenterManagementAddress": { "description": "The DNS hostname or IP address of the Hitachi Ops Center API Configuration Manager used to manage the Hitachi Virtual Storage Platform.", "type": "string", "x-omitempty": true } } } ] }, "asset.OrchestrationHsmVmwareVcenterOptions": { "title": "Asset:Orchestration Hsm Vmware Vcenter Options", "description": "Captures configuration specific to the VMware Vcenter target for the Hardware Support Manager.", "x-allOf-name": "asset.OrchestrationHsmVmwareVcenterOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.OrchestrationHsmVmwareVcenterOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.OrchestrationHsmVmwareVcenterOptions" ], "default": "asset.OrchestrationHsmVmwareVcenterOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.OrchestrationHsmVmwareVcenterOptions" ], "default": "asset.OrchestrationHsmVmwareVcenterOptions", "x-enum-as-string": true }, "HsmEnabled": { "description": "HsmEnabled controls whether Hardware Support Manager is enabled or not. vCenter Server version 7.0 or later.", "type": "boolean", "x-omitempty": true }, "IsClientSecretSet": { "description": "Indicates whether the value of the 'clientSecret' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.OrchestrationService": { "title": "Asset:Orchestration Service", "description": "OrchestrationService provides the necessary configuration details to enable Intersight Orchestration on the selected managed target. Subject to licensing.", "x-allOf-name": "asset.OrchestrationService", "allOf": [ { "$ref": "#/components/schemas/asset.Service" } ] }, "asset.ParentConnectionSignature": { "title": "Asset:Parent Connection Signature", "description": "A signature generated by a device connector with its private key. Signature is passed to leaf device connectors to authenticate connectivity between devices.", "x-allOf-name": "asset.ParentConnectionSignature", "allOf": [ { "$ref": "#/components/schemas/asset.ClaimSignature" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ParentConnectionSignature', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ParentConnectionSignature" ], "default": "asset.ParentConnectionSignature", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ParentConnectionSignature" ], "default": "asset.ParentConnectionSignature", "x-enum-as-string": true }, "DeviceId": { "description": "The moid of the parent device registration.", "type": "string", "x-omitempty": true }, "NodeId": { "description": "The node identity of the parent device, corresponds to the parents ClusterMember.memberIdentity. Used on connect to establish through which device in a cluster the child is connected through.", "type": "string", "x-omitempty": true } } } ] }, "asset.PreClaim": { "title": "Asset:Pre Claim", "description": "The PreClaim object is a specialized component of the device management system designed to facilitate the completion of the claim process for pre-provisioned assets. It acts as a bridge for targets that are defined in the system before their physical endpoints have established a connection to the management platform.\n#### Purpose\nA PreClaim serves to facilitate the completion of the claim process for hardware that has been staged or provisioned in advance. The object specifically manages the association between a pre-defined target and the unique security credentials of the connecting hardware.\n#### Key Concepts\n- **Secure Validation**: Facilitates the completion of the claim process by requiring a security token and serial number, ensuring that only authorized physical devices can assume the identity of a pre-provisioned target.\n- **Lifecycle Transition**: Manages the status of the claim from an initial pre-provisioned state to a finalized \"claimed\" state, at which point the device is fully integrated and manageable.\n- **Role-Based Management**: Access is strictly governed by specific privilege sets, such as Account Administrator and Claim Device roles, ensuring that only authorized personnel can complete the onboarding of assets.", "x-allOf-name": "asset.PreClaim", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.PreClaim', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.PreClaim" ], "default": "asset.PreClaim", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.PreClaim" ], "default": "asset.PreClaim", "x-enum-as-string": true }, "SecurityToken": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/SecurityTokens').", "type": "string", "writeOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "Obtained from the device connector management UI or API (REST endpoint '/connector/DeviceIdentifiers').", "type": "string", "x-omitempty": true }, "Target": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.PrivateKeyCredential": { "title": "Asset:Private Key Credential", "description": "A credential which performs authentication based on a private key for targets like SSH Endpoint. PrivateKeyCredential used to establish password-less SSH connection to the endpoint.", "x-allOf-name": "asset.PrivateKeyCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.PrivateKeyCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.PrivateKeyCredential" ], "default": "asset.PrivateKeyCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.PrivateKeyCredential" ], "default": "asset.PrivateKeyCredential", "x-enum-as-string": true }, "IsPassphraseSet": { "description": "Indicates whether the value of the 'passphrase' property has been set.", "type": "boolean", "default": false, "readOnly": true, "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 }, "Passphrase": { "description": "The passphrase associated with the private key - Optional.", "type": "string", "writeOnly": true, "x-omitempty": true }, "PrivateKey": { "description": "The private key used to authenticate with a managed target. The corresponding public key needs to be added in the auth list of the remote endpoint.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Username": { "description": "The username used to authenticate with a managed target.", "type": "string", "x-omitempty": true } } } ] }, "asset.ProductInformation": { "title": "Asset:Product Information", "description": "Type for saving the product information.", "x-allOf-name": "asset.ProductInformation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ProductInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ProductInformation" ], "default": "asset.ProductInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ProductInformation" ], "default": "asset.ProductInformation", "x-enum-as-string": true }, "BillTo": { "description": "Billing address provided by customer while buying this Cisco product.", "$ref": "#/components/schemas/asset.AddressInformation", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Short description of the Cisco product that helps identify the product easily. example \"DISTI:UCS 6248UP 1RU Fabric Int/No PSU/32 UP/ 12p LIC\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Family": { "description": "Family that the product belongs to. Example \"UCSB\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Group": { "description": "Group that the product belongs to. It is one higher level categorization above family. example \"Switch\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Number": { "description": "Product number that identifies the product. example PID. example \"UCS-FI-6248UP-CH2\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ShipTo": { "description": "Shipping address provided by customer while buying this Cisco product.", "$ref": "#/components/schemas/asset.AddressInformation", "readOnly": true, "x-omitempty": true }, "SubType": { "description": "Sub type of the product being specified. example \"UCS 6200 SER\".", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.ScopedTargetConnection": { "title": "Asset:Scoped Target Connection", "description": "ScopedTargetConnection provides the necessary details for Intersight to connect to and authenticate with a managed scoped target such as msSQL, mySQL and Oracle Database etc.", "x-allOf-name": "asset.ScopedTargetConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ScopedTargetConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ScopedTargetConnection" ], "default": "asset.ScopedTargetConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ScopedTargetConnection" ], "default": "asset.ScopedTargetConnection", "x-enum-as-string": true }, "FullValidation": { "description": "When this flag is set to true, every IWO entity in the scope targets will be checked and discovery of the scope target will be regarded as a failure when anyone of these entities cannot be connected and validated.", "type": "boolean", "x-omitempty": true }, "IsSecure": { "description": "Indicates whether a connection to the target should be established using TLS.", "type": "boolean", "default": true, "x-omitempty": true }, "Port": { "description": "The port number to be used to connect to the managed target. Values 1-65535 indicate a port number to be used. A value of 0 is not a valid port number and instead indicates that the default management port, as defined by the documentation of the managed target, should be used to establish a connection.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 65535, "x-omitempty": true }, "Scope": { "description": "The group id of IWO entities upon which the discover of a scoped target is performed. For example, a database target may be scoped to the group of virtual machines upon which the database application is running. Scope value is group id created for all those virtual machines in this scope.", "type": "string", "x-omitempty": true } } } ] }, "asset.Service": { "title": "Asset:Service", "description": "A service that is enabled on a managed target. For example, Intersight Orchestration or Intersight Workload Optimizer.", "x-allOf-name": "asset.Service", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Service', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "asset.OrchestrationService", "asset.TerraformIntegrationService", "asset.VirtualizationService", "asset.WorkloadOptimizerService" ], "x-enum-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": [ "asset.OrchestrationService", "asset.TerraformIntegrationService", "asset.VirtualizationService", "asset.WorkloadOptimizerService" ], "x-enum-as-string": true }, "Options": { "description": "Captures configuration that is specific to a target type for a specific service.", "$ref": "#/components/schemas/asset.ServiceOptions", "x-omitempty": true } } } ] }, "asset.ServiceNowCredential": { "title": "Asset:Service Now Credential", "description": "Credentials for authenticating with a ServiceNow target. Management of a ServiceNow target leverages multiple management interfaces and this credential object contains all necessary credentials.", "x-allOf-name": "asset.ServiceNowCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.ServiceNowCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.ServiceNowCredential" ], "default": "asset.ServiceNowCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.ServiceNowCredential" ], "default": "asset.ServiceNowCredential", "x-enum-as-string": true }, "OauthAuthenticationCredential": { "description": "Optional client id/secret credential used for OAuth authentication with ServiceNow target. ServiceNow requires this to be used for OAuth authentication combining with user/password credential.", "$ref": "#/components/schemas/asset.OauthClientIdSecretCredential", "x-omitempty": true }, "UserPasswordCredential": { "description": "Minimum required user/password credential to validate and discover ServiceNow target.", "$ref": "#/components/schemas/asset.UsernamePasswordCredential", "x-omitempty": true } } } ] }, "asset.ServiceOptions": { "title": "Asset:Service Options", "description": "ServiceOptions captures configuration that is specific to a target type for a specific service.", "x-allOf-name": "asset.ServiceOptions", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "asset.SplunkTokenCredential": { "title": "Asset:Splunk Token Credential", "description": "A credential which performs authentication based on Splunk token.", "x-allOf-name": "asset.SplunkTokenCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SplunkTokenCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SplunkTokenCredential" ], "default": "asset.SplunkTokenCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SplunkTokenCredential" ], "default": "asset.SplunkTokenCredential", "x-enum-as-string": true }, "IsTokenSet": { "description": "Indicates whether the value of the 'token' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Token": { "description": "The Splunk token used to authenticate with a managed target.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "asset.SshConnection": { "title": "Asset:Ssh Connection", "description": "SshConnection provides the necessary details for Intersight to connect and authenticate with a managed target over an SSH connection.", "x-allOf-name": "asset.SshConnection", "allOf": [ { "$ref": "#/components/schemas/asset.Connection" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SshConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SshConnection" ], "default": "asset.SshConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SshConnection" ], "default": "asset.SshConnection", "x-enum-as-string": true }, "ManagementAddress": { "description": "The DNS hostname or IPv4 Address to be used to connect to the managed target.", "type": "string", "x-omitempty": true }, "Port": { "description": "The port number to be used to connect to the managed target. Valid values are 1 - 65535. If not provided, a default port of 22 is used to establish the SSH connection to the given target.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 65535, "x-omitempty": true } } } ] }, "asset.Subscription.Response": { "description": "The response body of a HTTP GET request for the 'asset.Subscription' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.Subscription' resources.", "x-one-of-name": "asset.Subscription.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.Subscription.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.Subscription.Relationship": { "description": "A relationship to the 'asset.Subscription' resource, or the expanded 'asset.Subscription' resource, or the 'null' value.", "x-one-of-name": "asset.Subscription.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.Subscription" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.Subscription": { "title": "Asset:Subscription", "description": "The Subscription object is central to managing consumption-based subscriptions within the Cisco technology ecosystem. It encapsulates details about the subscriptions linked to Cisco devices, facilitating automated updates and management through integration with Cisco Install Base.\n#### Purpose\nSubscription provides a comprehensive structure for managing consumption-based subscriptions, ensuring seamless integration with Cisco Install Base for accurate data representation and updates. This information is also queried by downstream OPUS team for billing purposes. \n#### Key Concepts\n- **Integration:** Automates subscription management through real-time updates from Cisco Install Base, ensuring data accuracy and currency.\n- **Data Management:** Supports efficient tracking and management of consumption-based subscriptions.\n- **Access Control:** Ensures secure handling of subscription data through defined privileges and permissions.\n- **Relationship Management:** Maintains robust linkage with associated accounts and deployments, supporting comprehensive subscription management.", "x-allOf-name": "asset.Subscription", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Subscription', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.Subscription" ], "default": "asset.Subscription", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.Subscription" ], "default": "asset.Subscription", "x-enum-as-string": true }, "ApplicationName": { "description": "Application name reported by Cisco Install Base.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubscriptionRefId": { "description": "Identifies the consumption-based subscription.", "type": "string", "readOnly": true, "x-omitempty": true }, "Deployments": { "description": "An array of relationships to assetDeployment resources.", "type": "array", "items": { "$ref": "#/components/schemas/asset.Deployment.Relationship" }, "nullable": true, "readOnly": true }, "SubscriptionAccount": { "$ref": "#/components/schemas/asset.SubscriptionAccount.Relationship", "description": "A reference to a assetSubscriptionAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "asset.Subscription.List": { "title": "List of 'asset.Subscription' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.Subscription' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.Subscription' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.Subscription" }, "nullable": true } } } ] }, "asset.SubscriptionAccount.Response": { "description": "The response body of a HTTP GET request for the 'asset.SubscriptionAccount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.SubscriptionAccount' resources.", "x-one-of-name": "asset.SubscriptionAccount.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.SubscriptionAccount.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.SubscriptionAccount.Relationship": { "description": "A relationship to the 'asset.SubscriptionAccount' resource, or the expanded 'asset.SubscriptionAccount' resource, or the 'null' value.", "x-one-of-name": "asset.SubscriptionAccount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.SubscriptionAccount" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.SubscriptionAccount": { "title": "Asset:Subscription Account", "description": "The SubscriptionAccount object is a foundational element within the subscription management framework, acting as a placeholder for the account collection. Its primary function is to ensure stability and continuity in subscription-related operations by preventing data updates during account change events.\n#### Purpose\nSubscriptionAccount acts as a stabilizing component within the subscription management system, safeguarding data integrity during account modifications. This provides a structured approach to manage and reference account-related subscription data.\n#### Key Concepts\n- **Data Stability:** Protects subscription data from unintended updates during account changes, ensuring operational consistency.\n- **Account Integration:** Serves as a reference point for subscription data, maintaining a clear linkage between accounts and subscriptions.\n- **Access Control:** Leveraging permissions, it ensures only authorized users can interact with account-related subscription data.\n- **Dependency Management:** Plays a key role in managing relationships and dependencies within the subscription ecosystem.", "x-allOf-name": "asset.SubscriptionAccount", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SubscriptionAccount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SubscriptionAccount" ], "default": "asset.SubscriptionAccount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SubscriptionAccount" ], "default": "asset.SubscriptionAccount", "x-enum-as-string": true }, "Account": { "$ref": "#/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." } } } ] }, "asset.SubscriptionAccount.List": { "title": "List of 'asset.SubscriptionAccount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.SubscriptionAccount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.SubscriptionAccount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.SubscriptionAccount" }, "nullable": true } } } ] }, "asset.SubscriptionDeviceContractInformation.Response": { "description": "The response body of a HTTP GET request for the 'asset.SubscriptionDeviceContractInformation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.SubscriptionDeviceContractInformation' resources.", "x-one-of-name": "asset.SubscriptionDeviceContractInformation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.SubscriptionDeviceContractInformation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.SubscriptionDeviceContractInformation": { "title": "Asset:Subscription Device Contract Information", "description": "The SubscriptionDeviceContractInformation object is a crucial component of asset management within the Cisco ecosystem, designed to encapsulate information regarding devices associated with consumption-based subscriptions. It plays a vital role in tracking device installation status, customer details, and managing returns and replacements.\n#### Purpose\nSubscriptionDeviceContractInformation serves as a comprehensive repository for device-related information under consumption-based subscriptions. It ensures a seamless integration with Cisco Install Base, providing up-to-date data on device status and associated customer information.\n#### Key Concepts\n- **Device Association:** Centralizes information about Cisco devices under subscriptions, facilitating efficient management and tracking.\n- **Integration with Install Base:** Listens to messages from Cisco Install Base for automated updates, ensuring accurate and current data representation.\n- **Ownership and Access:** Managed by the system with defined access privileges, supporting secure and controlled access by authorized users.\n- **Information Persistence:** Ensures data integrity and reliability by maintaining detailed records of device installation status and transaction history.", "x-allOf-name": "asset.SubscriptionDeviceContractInformation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SubscriptionDeviceContractInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SubscriptionDeviceContractInformation" ], "default": "asset.SubscriptionDeviceContractInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SubscriptionDeviceContractInformation" ], "default": "asset.SubscriptionDeviceContractInformation", "x-enum-as-string": true }, "DeviceId": { "description": "Unique identifier of the Cisco device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceInformation": { "description": "Detailed device information including installation status and customer address.", "$ref": "#/components/schemas/asset.DeviceInformation", "readOnly": true, "x-omitempty": true }, "DevicePid": { "description": "Product identifier for the specified Cisco device. It is used to distinguish between HyperFlex and UCS devices.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubscriptionRefId": { "description": "Identifies the consumption-based subscription.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceContractInformation": { "$ref": "#/components/schemas/asset.DeviceContractInformation.Relationship", "description": "A reference to a assetDeviceContractInformation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "asset.SubscriptionDeviceContractInformation.List": { "title": "List of 'asset.SubscriptionDeviceContractInformation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.SubscriptionDeviceContractInformation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.SubscriptionDeviceContractInformation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.SubscriptionDeviceContractInformation" }, "nullable": true } } } ] }, "asset.SudiInfo": { "title": "Asset:Sudi Info", "description": "The SUDI is an X.509v3 certificate, which maintains the product identifier and serial number. The identity is implemented at manufacturing and chained to a publicly identifiable root certificate authority. It can be used as an unchangeable identity for configuration, security, auditing, and management. This structure contains the SUDI information read from the device's Trust Anchor Module (TAM).\nWhen the Intersight service receives a SUDI signature, it performs the following steps: 1. Validate the SUDI certificate is valid and has been issued by a trusted Certificate Authority. 2. Validate the 'signature'. In DC ApiVersion >= 16, the signature is expected to be a JWT signed by the TAM private key. 3. Set the 'status' property to indicate whether the signature is valid or not.", "x-allOf-name": "asset.SudiInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.SudiInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.SudiInfo" ], "default": "asset.SudiInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.SudiInfo" ], "default": "asset.SudiInfo", "x-enum-as-string": true }, "Jti": { "description": "The SUDI challenge jti generated by Intersight. The device reads the current JTI and signs it as part of its SUDI claims and sends to Intersight. Intersight verifies SUDI with the JTI claim. A new JTI is generated after each time a device sends updated SUDI information.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "The device model (PID) extracted from the X.509 SUDI leaf certificate.", "type": "string", "readOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "The device SerialNumber extracted from the X.509 SUDI leaf certificate.", "type": "string", "readOnly": true, "x-omitempty": true }, "Signature": { "description": "The base64-encoding of a SUDI signature, signed with the provided Trust Anchor Module (TAM) private key and signatureScheme.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The validation status of the device.\n* `DeviceStatusUnknown` - SUDI validation is done on the establishment of a connection. Before a device connects or after it disconnects, the SUDI validation status is set to this value.\n* `Verified` - The SUDI signature and certificate have been validated by the device. The device PID, Serial Number, Status and X.509 certificates were validated by a Trusted Anchor Module. The Intersight services have not cross-validated the SUDI signature.\n* `EndToEndVerified` - The SUDI signature and certificate have been validated by the device and by the Intersight services. The device PID, Serial Number, Status and X.509 certificates were validated by a Trusted Anchor Module.\n* `ChallengeVerified` - The SUDI signature includes a challenge provided by Intersight which has been validated by Intersight. The SUDI signature and certificate have been validated by the device and by the Intersight services. The device PID, Serial Number, Status and X.509 certificates were validated by a Trusted Anchor Module.\n* `CertificateValidationFailed` - Validation of the certificate signing chain failed.\n* `UnsupportedSignatureScheme` - The SUDI signature scheme is not supported.\n* `SignatureValidationFailed` - Validation of the SUDI signature has failed.\n* `UnsupportedFirmware` - The firmware version of the Cisco IMC that is installed does not contain the SUDI APIs needed to perform validation.\n* `UnsupportedHardware` - The device is a model that does not contain a Trust Anchor Module (TAM) and thus cannot be validated.\n* `DeviceError` - The device returned an error when it received a SUDIrequrest request.\n* `DeviceNotResponding` - A request was sent to the device, but no response was received.\n* `InvalidSignatureEncoding` - The encoding of the SUDI signature is invalid.\n* `MissingSignature` - The SUDI signature is missing.\n* `MissingSignatureScheme` - The SUDI signature scheme is missing.\n* `MissingCertificate` - The SUDI certificate is missing.\n* `InvalidCertificateEncoding` - The encoding of the SUDI certificate is invalid.\n* `InvalidIdentity` - The model or serial number of the device is either missing or does not match the certificate attributes.\n* `Suspect` - The DC claims the SUDI has been verified, but there is no way to validate the claim.", "type": "string", "enum": [ "DeviceStatusUnknown", "Verified", "EndToEndVerified", "ChallengeVerified", "CertificateValidationFailed", "UnsupportedSignatureScheme", "SignatureValidationFailed", "UnsupportedFirmware", "UnsupportedHardware", "DeviceError", "DeviceNotResponding", "InvalidSignatureEncoding", "MissingSignature", "MissingSignatureScheme", "MissingCertificate", "InvalidCertificateEncoding", "InvalidIdentity", "Suspect" ], "default": "DeviceStatusUnknown", "readOnly": true, "x-omitempty": true }, "StatusDetails": { "description": "The detailed validation status of the device, such as an error message explaining why the validation failed.", "type": "string", "readOnly": true, "x-omitempty": true }, "SudiCertificate": { "description": "The X.509 SUDI leaf certificate from the Trust Anchor Module. The certificate is serialized in PEM format (Base64 encoded DER certificate).", "$ref": "#/components/schemas/x509.Certificate", "readOnly": true, "x-omitempty": true } } } ] }, "asset.Target.Response": { "description": "The response body of a HTTP GET request for the 'asset.Target' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'asset.Target' resources.", "x-one-of-name": "asset.Target.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/asset.Target.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "asset.Target.Relationship": { "description": "A relationship to the 'asset.Target' resource, or the expanded 'asset.Target' resource, or the 'null' value.", "x-one-of-name": "asset.Target.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/asset.Target" } ], "discriminator": { "propertyName": "ClassId" } }, "asset.Target": { "title": "Asset:Target", "description": "The Target object represents an entity managed by Intersight. It encompasses both physical and software entities, such as UCS servers or cloud accounts, and serves as the cornerstone for target management within Intersight's ecosystem.\n#### Purpose\nTarget serves as the interface for managing entities within Intersight, offering a comprehensive view of the status and capabilities of each managed entity. It supports the establishment of connections, monitoring, and service enablement, facilitating effective management of diverse targets.\n#### Key Concepts\n- **Type and Status Management:** Defines the type of the managed entity and provides insights into its connection and operational status.\n- **Service Integration:** Supports the enablement of services for the target, facilitating comprehensive management and optimization.\n- **Connection and Authentication:** Manages methods for connecting to targets, ensuring secure and reliable interaction between Intersight and the managed entities.\n- **Pre-provisioning Workflow**: Enables a \"claim-before-connect\" workflow, allowing system targets to be created and configured in anticipation of physical hardware deployment. It allows administrators to prepare the environment for new devices, ensuring that once a physical endpoint is connected, the transition to a fully managed state is secure and efficient. Pre provisioned Targets can complete their claim with by updating the associated asset.PreClaim object with the security token of the connected device.", "x-allOf-name": "asset.Target", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.Target', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.Target" ], "default": "asset.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.", "enum": [ "asset.Target" ], "default": "asset.Target", "x-enum-as-string": true }, "AlarmSummary": { "description": "AlarmSummary is a health score calculation and aggregation of alarm counts per severity of alarms which Intersight's ability to manage the Target.", "$ref": "#/components/schemas/asset.AlarmSummary", "readOnly": true, "x-omitempty": true }, "ClaimedByUserName": { "description": "The name or email id of the user who claimed the target.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClaimedTime": { "description": "The date at which the target was claimed to this account. For pre-provisioned targets this is the time at which the claim was completed.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Connections": { "type": "array", "items": { "description": "A list of methods for connecting to the managed target.", "$ref": "#/components/schemas/asset.Connection", "x-omitempty": true }, "minItems": 1, "maxItems": 1, "nullable": true }, "ConnectorVersion": { "description": "The Device Connector version for target types which are managed by via embedded Device Connector.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalIpAddress": { "description": "ExternalIpAddress is applicable for targets which are managed via an Intersight Device Connector. The value is the IP Address of the target as seen from Intersight. It is either the IP Address of the managed target's interface which has a route to the internet or a NAT IP Address when the target is deployed in a private network.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpAddress": { "type": "array", "items": { "description": "The IP Addresses of the managed target. There can be multiple management IPs depending on the number of elements managed (i.e. HA clusters) and in-band/out-of-band connectivity.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ManagementLocation": { "description": "The location from which Intersight manages the target.\n* `Unknown` - The management mechanism is not detected. Unknown is used as a default by the implementation and is not an allowed user input.\n* `Intersight` - Management of a target is performed directly from Intersight. Network connections are established from Intersight to a management interface of the Target and authenticated using user provided credentials.\n* `IntersightAssist` - Management of a target is performed via a selected Intersight Assist. Network connections are established from the Intersight Assist to a management interface of the Target.\n* `DeviceConnector` - An Intersight Device Connector running within the Target establishes a connection to Intersight and management of the target is performed via this connection.", "type": "string", "enum": [ "Unknown", "Intersight", "IntersightAssist", "DeviceConnector" ], "default": "Unknown", "x-createOnly": true, "x-omitempty": true }, "Name": { "description": "A user provided name for the managed target.", "type": "string", "x-omitempty": true }, "ProductId": { "type": "array", "items": { "description": "The product Id of the managed target.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ReadOnly": { "description": "For targets which are managed by an embedded Intersight Device Connector, this field indicates that an administrator of the target has disabled management operations of the Device Connector and only monitoring is permitted.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Services": { "type": "array", "items": { "description": "A list of services which are enabled for the managed target.", "$ref": "#/components/schemas/asset.Service", "x-omitempty": true }, "nullable": true }, "Status": { "description": "Status indicates if Intersight can establish a connection and authenticate with the managed target. Status does not include information about the functional health of the target.\n* `` - The target details have been persisted but Intersight has not yet attempted to connect to the target.\n* `Connected` - Intersight is able to establish a connection to the target and initiate management activities.\n* `NotConnected` - Intersight is unable to establish a connection to the target.\n* `ClaimInProgress` - Claim of the target is in progress. A connection to the target has not been fully established.\n* `UnclaimInProgress` - Unclaim of the target is in progress. Intersight is able to connect to the target and all management operations are supported.\n* `Unclaimed` - The device was un-claimed from the users account by an Administrator of the device. Also indicates the failure to claim Targets of type HTTP Endpoint in Intersight.\n* `Claimed` - Target of type HTTP Endpoint is successfully claimed in Intersight. Currently no validation is performed to verify the Target connectivity from Intersight at the time of creation. However invoking API from Intersight Orchestrator fails if this Target is not reachable from Intersight or if Target API credentials are incorrect.\n* `PreClaimed` - Target has been pre-claimed and is pending claim completion. Pre-claimed targets are pre-provisioned before endpoint is available to connect to Intersight, once target connects the claim can be completed by providing the security token to the pre-claim API.", "type": "string", "enum": [ "", "Connected", "NotConnected", "ClaimInProgress", "UnclaimInProgress", "Unclaimed", "Claimed", "PreClaimed" ], "default": "", "readOnly": true, "x-omitempty": true }, "StatusErrorReason": { "description": "StatusErrorReason provides additional context for the Status.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetId": { "type": "array", "items": { "description": "The identifier of the managed target such as serial number or UID.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetType": { "description": "The type of the managed target. For example a UCS Server or VMware Vcenter target.\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": "The vendor of the managed target.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." }, "AssignedLocation": { "$ref": "#/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." }, "Assist": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 }, "Reservation": { "$ref": "#/components/schemas/resource.Reservation.Relationship", "description": "A reference to a resourceReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "TrustPoint": { "$ref": "#/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." }, "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.", "readOnly": true } } } ] }, "asset.Target.List": { "title": "List of 'asset.Target' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'asset.Target' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'asset.Target' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/asset.Target" }, "nullable": true } } } ] }, "asset.TargetKey": { "title": "Asset:Target Key", "description": "Holds a key and signature that can be sent in a device registration request to associate it with a target.", "x-allOf-name": "asset.TargetKey", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.TargetKey', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.TargetKey" ], "default": "asset.TargetKey", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.TargetKey" ], "default": "asset.TargetKey", "x-enum-as-string": true }, "IsPrivateKeySet": { "description": "Indicates whether the value of the 'privateKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "asset.TargetSignature": { "title": "Asset:Target Signature", "description": "A signature generated by Intersight on creation of a target.", "x-allOf-name": "asset.TargetSignature", "allOf": [ { "$ref": "#/components/schemas/asset.ClaimSignature" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.TargetSignature', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.TargetSignature" ], "default": "asset.TargetSignature", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.TargetSignature" ], "default": "asset.TargetSignature", "x-enum-as-string": true }, "TargetId": { "description": "The moid of the associated target.", "type": "string", "x-omitempty": true } } } ] }, "asset.TargetStatusDetails": { "title": "Asset:Target Status Details", "description": "TargetStatusDetails provides per component detailed status information. This information is normalized into a single status value which is presented to users. Alarms may be raised based on the status details.", "x-allOf-name": "asset.TargetStatusDetails", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "asset.TerraformIntegrationService": { "title": "Asset:Terraform Integration Service", "description": "TerraformIntegrationService provides the necessary configuration details to enable Intersight Cloud Region on the selected Terraform Cloud.", "x-allOf-name": "asset.TerraformIntegrationService", "allOf": [ { "$ref": "#/components/schemas/asset.Service" } ] }, "asset.TerraformIntegrationTerraformAgentOptions": { "title": "Asset:Terraform Integration Terraform Agent Options", "description": "Cloud options for Terrraform Agent platform type.", "x-allOf-name": "asset.TerraformIntegrationTerraformAgentOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.TerraformIntegrationTerraformAgentOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.TerraformIntegrationTerraformAgentOptions" ], "default": "asset.TerraformIntegrationTerraformAgentOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.TerraformIntegrationTerraformAgentOptions" ], "default": "asset.TerraformIntegrationTerraformAgentOptions", "x-enum-as-string": true }, "ManagedHosts": { "type": "array", "items": { "description": "Managed hosts collection for Terraform Agent platform type.", "type": "string", "x-omitempty": true }, "nullable": true }, "TerraformAgentPoolName": { "description": "Agent pool name for Terraform Agent platform type.", "type": "string", "x-omitempty": true }, "TerraformOrganization": { "description": "Organization for Terraform Agent platform type.", "type": "string", "x-omitempty": true } } } ] }, "asset.TerraformIntegrationTerraformCloudOptions": { "title": "Asset:Terraform Integration Terraform Cloud Options", "description": "Cloud options for Terraform Cloud platform type.", "x-allOf-name": "asset.TerraformIntegrationTerraformCloudOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.TerraformIntegrationTerraformCloudOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.TerraformIntegrationTerraformCloudOptions" ], "default": "asset.TerraformIntegrationTerraformCloudOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.TerraformIntegrationTerraformCloudOptions" ], "default": "asset.TerraformIntegrationTerraformCloudOptions", "x-enum-as-string": true }, "DefaultManagedHosts": { "type": "array", "items": { "description": "List of default IP addresses, Hostnames or subnets of endpoints that will be configured by the Terraform Agent.", "type": "string", "x-omitempty": true }, "nullable": true }, "DefaultTerraformOrganization": { "description": "Default organization for Terraform Cloud platform type.", "type": "string", "x-omitempty": true } } } ] }, "asset.Token": { "title": "Asset:Token", "description": "A token that is generated by an Intersight user to claim a device. The token is used by the device administrator to configure and claim the device connector to the users Intersight account.", "x-allOf-name": "asset.Token", "allOf": [ { "$ref": "#/components/schemas/asset.ClaimSignature" } ] }, "asset.UsernamePasswordCredential": { "title": "Asset:Username Password Credential", "description": "A credential which performs authentication based on a username and password.", "x-allOf-name": "asset.UsernamePasswordCredential", "allOf": [ { "$ref": "#/components/schemas/asset.Credential" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.UsernamePasswordCredential', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.UsernamePasswordCredential" ], "default": "asset.UsernamePasswordCredential", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.UsernamePasswordCredential" ], "default": "asset.UsernamePasswordCredential", "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 used to authenticate with a managed target.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Username": { "description": "The username used to authenticate with a managed target.", "type": "string", "x-omitempty": true } } } ] }, "asset.VirtualizationAmazonWebServiceOptions": { "title": "Asset:Virtualization Amazon Web Service Options", "description": "Captures Virtualization Service configuration specific to AWS.", "x-allOf-name": "asset.VirtualizationAmazonWebServiceOptions", "allOf": [ { "$ref": "#/components/schemas/asset.VirtualizationCloudOptions" } ] }, "asset.VirtualizationCloudOptions": { "title": "Asset:Virtualization Cloud Options", "description": "Captures Virtualization service configuration.", "x-allOf-name": "asset.VirtualizationCloudOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.VirtualizationCloudOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "asset.VirtualizationAmazonWebServiceOptions" ], "default": "asset.VirtualizationAmazonWebServiceOptions", "x-enum-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": [ "asset.VirtualizationAmazonWebServiceOptions" ], "default": "asset.VirtualizationAmazonWebServiceOptions", "x-enum-as-string": true }, "ManagedRegions": { "type": "array", "items": { "description": "List of regions managed by this target. Needs to have reference to cloud.Regions.", "$ref": "#/components/schemas/mo.MoRef", "x-omitempty": true }, "minItems": 1, "nullable": true }, "RegionGroup": { "description": "The name of the region group to which the managedRegions belong. Populated from the group property in cloud.Regions.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.VirtualizationService": { "title": "Asset:Virtualization Service", "description": "The necessary configuration details to enable Intersight Virtualization features on the selected managed target.", "x-allOf-name": "asset.VirtualizationService", "allOf": [ { "$ref": "#/components/schemas/asset.Service" } ] }, "asset.VmHost": { "title": "Asset:Vm Host", "description": "Type for saving VM host details.", "x-allOf-name": "asset.VmHost", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.VmHost', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.VmHost" ], "default": "asset.VmHost", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.VmHost" ], "default": "asset.VmHost", "x-enum-as-string": true }, "AccountMoid": { "description": "Reference to virtualization target account ID.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterIdentity": { "description": "Reference to virtualization cluster identity.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterMoid": { "description": "Reference to virtualization cluster ID.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterName": { "description": "Reference to virtualization cluster name.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerAmazonWebServicesBillingOptions": { "title": "Asset:Workload Optimizer Amazon Web Services Billing Options", "description": "Captures configuration specific to the Amazon web service (AWS) target for Workload Optimizer service. Following explanation is for S3 parameters for configuring billing and costs reports. S3 bucket parameters help in programmatically gaining access to the S3 bucket for billing and cost management. The user must first have Amazon web service billing data being generated for their Amazon web service account. Since this is not enabled in Amazon web service by default, follow the instructions from Amazon web service to generate the bill hourly. Use \"Daily\" time unit frequency on which report data are measured and displayed. [link](https://aws.amazon.com/blogs/aws/new-programmatic-access-to-aws-billing-data/) [link](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-getting-started.html).", "x-allOf-name": "asset.WorkloadOptimizerAmazonWebServicesBillingOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerAmazonWebServicesBillingOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerAmazonWebServicesBillingOptions" ], "default": "asset.WorkloadOptimizerAmazonWebServicesBillingOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerAmazonWebServicesBillingOptions" ], "default": "asset.WorkloadOptimizerAmazonWebServicesBillingOptions", "x-enum-as-string": true }, "CostAndUsageReportBucket": { "description": "Name of S3 bucket that contains the Amazon web service Cost and Usage report to get cloud service spend.", "type": "string", "x-omitempty": true }, "CostAndUsageReportPath": { "description": "Report path prefix for the Amazon web service cost and usage report to get cloud service spend.", "type": "string", "x-omitempty": true }, "CostAndUsageReportRegion": { "description": "Region for S3 bucket that contains the Amazon web service Cost and Usage report to get cloud service spend.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerDynatraceOptions": { "title": "Asset:Workload Optimizer Dynatrace Options", "description": "Captures configuration specific to the Dynatrace target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerDynatraceOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerDynatraceOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerDynatraceOptions" ], "default": "asset.WorkloadOptimizerDynatraceOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerDynatraceOptions" ], "default": "asset.WorkloadOptimizerDynatraceOptions", "x-enum-as-string": true }, "CollectTagInfo": { "description": "Collect tag information from Dynatrace.", "type": "boolean", "default": false, "x-omitempty": true }, "CollectVmMetrics": { "description": "Overwrite Hypervisor or Cloud Provider Virtual Machine metrics with data from the target.", "type": "boolean", "x-omitempty": true }, "EnvironmentId": { "description": "Each environment monitored with Dynatrace is identified with a unique character string\u2014the environment ID. The Dynatrace API relies heavily on environment IDs to ensure that it pulls monitoring data from and pushes relevant external events to the correct Dynatrace environments.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions": { "title": "Asset:Workload Optimizer Google Cloud Platform Billing Options", "description": "Captures configuration specific to the Google Cloud Platform (GCP) Billing target for Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions" ], "default": "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions" ], "default": "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions", "x-enum-as-string": true }, "BillingAccountId": { "description": "The Google Cloud Platform (GCP) Billing Account ID.", "type": "string", "x-omitempty": true }, "CostExportDataSetName": { "description": "Name of Google BigQuery Cost Export Data Set which is the dataset for the billed cost export.", "type": "string", "x-omitempty": true }, "CostExportTableName": { "description": "Google BigQuery Cost Export Table Name. This table will store the exported data from the Cost Export.", "type": "string", "x-omitempty": true }, "PricingExportDataSetName": { "description": "Name of the BigQuery Pricing Export Data Set which is the dataset for negotiated pricing.", "type": "string", "x-omitempty": true }, "PricingExportTableName": { "description": "The Google BigQuery Pricing Export Table Name field is auto-populated with the table used in BigQuery, cloud_pricing_export. There is no need to modify this name, unless you use a different table for negotiated pricing. The Default name is \"cloud_pricing_export\".", "type": "string", "x-omitempty": true }, "ProjectId": { "description": "The unique ID assigned to the project containing the cost and pricing exports. If the exports are in separate projects, multiple billing targets will be necessary.", "type": "string", "x-omitempty": true }, "ResourceLevelCostEnabled": { "description": "This flag will enable querying of detailed usage cost with resource level information included. If not enabled, cost export data will be queried, if dataset and table name are provided.", "type": "boolean", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerHypervOptions": { "title": "Asset:Workload Optimizer Hyperv Options", "description": "Captures configuration specific to the Hyper-V target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerHypervOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerHypervOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerHypervOptions" ], "default": "asset.WorkloadOptimizerHypervOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerHypervOptions" ], "default": "asset.WorkloadOptimizerHypervOptions", "x-enum-as-string": true }, "DiscoverHostCluster": { "description": "When enabled, all Hyper-V hosts in the same cluster of specified Hyper-V host target will be discovered Each server must still be configured to allow remote management (for example, configuring WinRM using a GPO).", "type": "boolean", "x-omitempty": true }, "FullDomainName": { "description": "Fully qualified domain name of the Hyper-V target. It is used to get the name of the Hyper-V cluster node and do Active Directory authentication process through Kerberos scheme.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions": { "title": "Asset:Workload Optimizer Microsoft Azure Application Insights Options", "description": "Captures configuration specific to the Microsoft Azure Application Intersight target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions", "x-enum-as-string": true }, "EnrollmentNumber": { "description": "Enrollment number of this Azure account.", "type": "string", "x-omitempty": true }, "OfferId": { "description": "The offer ID of this account. Default value is \"MS-AZR-0003P\", a pay-as-you-go subscription lets you pay for the services and resources that you use on a monthly basis.", "type": "string", "x-omitempty": true }, "SubscriptionId": { "description": "The Azure Subscription ID.", "type": "string", "x-omitempty": true }, "TenantId": { "description": "Tenant ID associated with Azure Account.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftAzureBillingOptions": { "title": "Asset:Workload Optimizer Microsoft Azure Billing Options", "description": "Captures configuration specific to the Microsoft Azure Billing target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftAzureBillingOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftAzureBillingOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureBillingOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureBillingOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureBillingOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureBillingOptions", "x-enum-as-string": true }, "BillingAccountId": { "description": "The Microsoft Azure Billing Account ID.", "type": "string", "x-omitempty": true }, "CostExportName": { "description": "Name of the Cost Export Data that exports cost management data.", "type": "string", "x-omitempty": true }, "TenantId": { "description": "Id of the tenant used while authenticating the managed target.", "type": "string", "x-omitempty": true }, "UseCostExport": { "description": "For larger topologies, use cost export to fetch billed cost data.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions": { "title": "Asset:Workload Optimizer Microsoft Azure Enterprise Agreement Options", "description": "Captures configuration specific to the Microsoft Azure Enterprise Agreement target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions", "x-enum-as-string": true }, "EnrollmentNumber": { "description": "Enrollment number for Azure EA.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions": { "title": "Asset:Workload Optimizer Microsoft Azure Service Principal Options", "description": "Captures configuration specific to the Microsoft Azure Service Principal target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions" ], "default": "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions", "x-enum-as-string": true }, "AzureCloudType": { "description": "Azure has different endpoints for managing Germany subscriptions. Azure cloud type helps in differentiating between regular subscriptions and Germany subscriptions to manage the Azure services for workload optimization. Documentation for germany cloud [link](https://docs.microsoft.com/en-us/azure/germany/germany-manage-subscriptions).\n* `Global` - Global cloud type for Azure subscription.\n* `Germany` - Germany cloud type for Azure subscription.", "type": "string", "enum": [ "Global", "Germany" ], "default": "Global", "x-omitempty": true }, "TenantId": { "description": "ID of the tenant used while authenticating the managed target.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerMicrosoftSqlServerOptions": { "title": "Asset:Workload Optimizer Microsoft Sql Server Options", "description": "Captures configuration specific to the Microsoft SQL Server target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerMicrosoftSqlServerOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerMicrosoftSqlServerOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerMicrosoftSqlServerOptions" ], "default": "asset.WorkloadOptimizerMicrosoftSqlServerOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerMicrosoftSqlServerOptions" ], "default": "asset.WorkloadOptimizerMicrosoftSqlServerOptions", "x-enum-as-string": true }, "BrowserServicePort": { "description": "Port that Microsoft SQL Server Browser listens for incoming requests for SQL Server resources and provides information about SQL Server instances that are installed on the computer. When this port is specified, Database will be communicated through the Browser Service with this port instead of default SQLServer port.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 65535, "x-omitempty": true }, "DiscoveryPath": { "description": "Discovery path to define if its scope target entities or hostname or IP address.", "type": "string", "default": "targetEntities", "x-omitempty": true }, "FullDomainName": { "description": "Active Directory domain, if required for this account.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerNewRelicOptions": { "title": "Asset:Workload Optimizer New Relic Options", "description": "Captures configuration specific to the NewRelic target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerNewRelicOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerNewRelicOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerNewRelicOptions" ], "default": "asset.WorkloadOptimizerNewRelicOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerNewRelicOptions" ], "default": "asset.WorkloadOptimizerNewRelicOptions", "x-enum-as-string": true }, "AccountId": { "description": "Your NewRelic account id.", "type": "string", "x-omitempty": true }, "CollectTagInfo": { "description": "Collect tag information from NewRelic.", "type": "boolean", "default": false, "x-omitempty": true }, "CollectVmMetrics": { "description": "Overwrite Hypervisor or Cloud Provider Virtual Machine metrics with data from the target.", "type": "boolean", "x-omitempty": true }, "Region": { "description": "The region associated with the NewRelic account.\n* `US` - The United States (US) region.\n* `EU` - The European Union (EU) region.", "type": "string", "enum": [ "US", "EU" ], "default": "US", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerOpenStackOptions": { "title": "Asset:Workload Optimizer Open Stack Options", "description": "Captures configuration specific to the OpenStack target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerOpenStackOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerOpenStackOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerOpenStackOptions" ], "default": "asset.WorkloadOptimizerOpenStackOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerOpenStackOptions" ], "default": "asset.WorkloadOptimizerOpenStackOptions", "x-enum-as-string": true }, "Domain": { "description": "OpenStack Identity Service (keystone) domain name. Domain is an additional namespaces you can create in keystone to partition users, groups, and projects. Default domain name value is \"Default\".", "type": "string", "x-omitempty": true }, "Tenant": { "description": "The name of tenant which has assigned administrator role this OpenStack target user is in. A tenant or project is referred to as a group of users of OpenStack. Each tenant can be assigned a role which gives all its member users their rights and privileges to perform a specific set of operations.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerOracleDatabaseServerOptions": { "title": "Asset:Workload Optimizer Oracle Database Server Options", "description": "Captures configuration specific to the Oracle Database Server target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerOracleDatabaseServerOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerOracleDatabaseServerOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerOracleDatabaseServerOptions" ], "default": "asset.WorkloadOptimizerOracleDatabaseServerOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerOracleDatabaseServerOptions" ], "default": "asset.WorkloadOptimizerOracleDatabaseServerOptions", "x-enum-as-string": true }, "DatabaseId": { "description": "A unique name for an Oracle database instance on a specific host.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerRedHatOpenStackOptions": { "title": "Asset:Workload Optimizer Red Hat Open Stack Options", "description": "Captures configuration specific to the RedHat OpenStack target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerRedHatOpenStackOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerRedHatOpenStackOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerRedHatOpenStackOptions" ], "default": "asset.WorkloadOptimizerRedHatOpenStackOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerRedHatOpenStackOptions" ], "default": "asset.WorkloadOptimizerRedHatOpenStackOptions", "x-enum-as-string": true }, "Domain": { "description": "RedHat OpenStack Identity Service (keystone) domain name. Domain is an additional namespaces you can create in keystone to partition users, groups, and projects. Default domain name value is \"Default\".", "type": "string", "x-omitempty": true }, "Tenant": { "description": "The name of tenant which has assigned administrator role this RedHat OpenStack target user is in. A tenant or project is referred to as a group of users of RedHat OpenStack. Each tenant can be assigned a role which gives all its member users their rights and privileges to perform a specific set of operations.", "type": "string", "x-omitempty": true } } } ] }, "asset.WorkloadOptimizerService": { "title": "Asset:Workload Optimizer Service", "description": "WorkloadOptimizerService provides the necessary configuration details to enable Intersight Workflow Optimizer on the selected managed target. Subject to licensing.", "x-allOf-name": "asset.WorkloadOptimizerService", "allOf": [ { "$ref": "#/components/schemas/asset.Service" } ] }, "asset.WorkloadOptimizerVmwareVcenterOptions": { "title": "Asset:Workload Optimizer Vmware Vcenter Options", "description": "Captures configuration specific to the VMware Vcenter target for the Workload Optimizer service.", "x-allOf-name": "asset.WorkloadOptimizerVmwareVcenterOptions", "allOf": [ { "$ref": "#/components/schemas/asset.ServiceOptions" }, { "type": "object", "description": "Definition of the list of properties defined in 'asset.WorkloadOptimizerVmwareVcenterOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "asset.WorkloadOptimizerVmwareVcenterOptions" ], "default": "asset.WorkloadOptimizerVmwareVcenterOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "asset.WorkloadOptimizerVmwareVcenterOptions" ], "default": "asset.WorkloadOptimizerVmwareVcenterOptions", "x-enum-as-string": true }, "DatastoreBrowsingEnabled": { "description": "DatastoreBrowsingEnabled controls whether Workload Optimizer scans vCenter datastores to identify files which are not used and can be deleted to reclaim space and improve actual disk utilization. For example orphaned VMDK files.", "type": "boolean", "x-omitempty": true }, "GuestMetricsEnabled": { "description": "Enable retrieval of advanced memory metrics. Only supported on vCenter Server version 6.5U3 or later. Guest VMs must run VMWare Tools 10.3.2 Build 10338 or later.", "type": "boolean", "x-omitempty": true } } } ] }, "auditd.LogMonitorType": { "title": "Auditd:Log Monitor Type", "description": "The log monitor is used to configure monitoring of specific log events in the AuditD feature.", "x-allOf-name": "auditd.LogMonitorType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'auditd.LogMonitorType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "auditd.LogMonitorType" ], "default": "auditd.LogMonitorType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "auditd.LogMonitorType" ], "default": "auditd.LogMonitorType", "x-enum-as-string": true }, "All": { "description": "It can be configured to monitor all the log events.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "AuthLogFiles": { "description": "It can be configured to monitor log events only w.r.t auth log files changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "CronFiles": { "description": "It can be configured to monitor log events only w.r.t cron files changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "DnsClientFiles": { "description": "It can be configured to monitor log events only w.r.t dns client files changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "Docker": { "description": "It can be configured to monitor log events only w.r.t Docker executions and file changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "KernelModuleMgmt": { "description": "It can be configured to monitor log events only w.r.t kernel module files changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "ProcessAudit": { "description": "It can be configured to monitor log events only w.r.t process execution audit.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "SystemLogFiles": { "description": "It can be configured to monitor log events only w.r.t system log files changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "SystemLoginReboot": { "description": "It can be configured to monitor log events only w.r.t system login reboot file changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "SystemSoftware": { "description": "It can be configured to monitor log events only w.r.t system software's binaries changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "SystemTimeChange": { "description": "It can be configured to monitor log events only w.r.t system time file changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "UserGroupConfigFiles": { "description": "It can be configured to monitor log events only w.r.t User Group Config Files changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true }, "UserPrivilegeMgmt": { "description": "It can be configured to monitor log events only w.r.t User Privilege management file changes.\n* `no` - Value to disable the specific monitoring rule.\n* `yes` - Value to enable the specific monitoring rule.", "type": "string", "enum": [ "no", "yes" ], "default": "no", "x-omitempty": true } } } ] }, "auditd.Policy.Response": { "description": "The response body of a HTTP GET request for the 'auditd.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 'auditd.Policy' resources.", "x-one-of-name": "auditd.Policy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/auditd.Policy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "auditd.Policy": { "title": "AuditD Policy", "description": "A policy to configure the kernel level AuditD settings in the Fabric Interconnect/Servers.", "x-allOf-name": "auditd.Policy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'auditd.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": [ "auditd.Policy" ], "default": "auditd.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": [ "auditd.Policy" ], "default": "auditd.Policy", "x-enum-as-string": true }, "AdminState": { "description": "Admin state for the AuditD feature.\n* `Disabled` - Admin configured Disabled State.\n* `Enabled` - Admin configured Enabled State.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true }, "AuditdLogLevel": { "description": "The log level for the AuditD feature. The default value is \"notifications\".\n* `notifications` - Generated logs are of Notification level, providing information about normal but significant system events requiring awareness.\n* `emergencies` - Generated logs will be of Emergency log level, indicating a critical and unstable system state.\n* `alerts` - Generated logs are of Alert level, indicating critical issues needing immediate attention to prevent system disruption.\n* `critical` - Generated logs are of Critical level, signaling severe issues that may cause system failure if not addressed immediately.\n* `errors` - Generated logs are of Error level, indicating significant problems that affect functionality but do not cause system failure.\n* `warnings` - Generated logs are of Warning level, highlighting potential issues that require attention but do not yet impact functionality.\n* `information` - Generated logs are of Information level, detailing routine operational messages without indicating any issues or errors.\n* `debugging` - Generated logs are of Debugging level, providing detailed information to help diagnose and troubleshoot system issues.", "type": "string", "enum": [ "notifications", "emergencies", "alerts", "critical", "errors", "warnings", "information", "debugging" ], "default": "notifications", "x-omitempty": true }, "LogMonitor": { "description": "Log monitor configuration for the AuditD feature.", "$ref": "#/components/schemas/auditd.LogMonitorType", "x-omitempty": true }, "Organization": { "$ref": "#/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": { "description": "An array of relationships to fabricBaseSwitchProfile resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fabric.BaseSwitchProfile.Relationship" }, "nullable": true } } } ] }, "auditd.Policy.List": { "title": "List of 'auditd.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'auditd.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 'auditd.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/auditd.Policy" }, "nullable": true } } } ] }, "blueprint.BaseGeneratedObjectSourceFromSelector": { "title": "Blueprint:Base Generated Object Source From Selector", "description": "Base type to capture common details of how the source object is provided from an existing object using a selector. The selector consists of a URL that is the REST API path to the source object, along with an odata query.", "x-allOf-name": "blueprint.BaseGeneratedObjectSourceFromSelector", "allOf": [ { "$ref": "#/components/schemas/blueprint.BaseGeneratedObjectSourceMetadata" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.BaseGeneratedObjectSourceFromSelector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "blueprint.GeneratedObjectSourceClone", "blueprint.GeneratedObjectSourceLookup", "blueprint.GeneratedObjectSourceMerge" ], "x-enum-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": [ "blueprint.GeneratedObjectSourceClone", "blueprint.GeneratedObjectSourceLookup", "blueprint.GeneratedObjectSourceMerge" ], "x-enum-as-string": true }, "SourceSelectors": { "type": "array", "items": { "description": "The selector to identify the source object.", "$ref": "#/components/schemas/blueprint.GeneratedObjectSourceSelector", "x-omitempty": true }, "nullable": true } } } ] }, "blueprint.BaseGeneratedObjectSourceMetadata": { "title": "Blueprint:Base Generated Object Source Metadata", "description": "Base type to capture common details of how the source object is provided.", "x-allOf-name": "blueprint.BaseGeneratedObjectSourceMetadata", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "blueprint.BlueprintDefinitionDependency": { "title": "Blueprint:Blueprint Definition Dependency", "description": "Definition to capture a dependency on another blueprint that is referred in this blueprint.", "x-allOf-name": "blueprint.BlueprintDefinitionDependency", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.BlueprintDefinitionDependency', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.BlueprintDefinitionDependency" ], "default": "blueprint.BlueprintDefinitionDependency", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.BlueprintDefinitionDependency" ], "default": "blueprint.BlueprintDefinitionDependency", "x-enum-as-string": true }, "BlueprintDefinition": { "description": "The system resolved reference to the blueprint.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "BlueprintName": { "description": "The qualified name of blueprint.", "type": "string", "x-omitempty": true }, "CatalogMoid": { "description": "Specify the catalog moid that this blueprint belongs too. When catalog moid is not specified then the catalog of the parent blueprint is used first and if no blueprint can be found in that catalog, then the system catalog is used.", "type": "string", "x-omitempty": true }, "Description": { "description": "The description of that describes the purpose of including this dependent blueprint.", "type": "string", "x-omitempty": true }, "InputParameters": { "description": "If any input of the nested blueprint needs to be modified in some form to include data from the parent blueprint, then the input parameters can be specified here.", "x-omitempty": true }, "Label": { "description": "A user defined label identifier for this blueprint.", "type": "string", "x-omitempty": true }, "Version": { "description": "The blueprint version. If not specified, the default version is used.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "blueprint.GeneratedObjectMetadata": { "title": "Blueprint:Generated Object Metadata", "description": "Type to capture the details of the generated objects.", "x-allOf-name": "blueprint.GeneratedObjectMetadata", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.GeneratedObjectMetadata', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.GeneratedObjectMetadata" ], "default": "blueprint.GeneratedObjectMetadata", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.GeneratedObjectMetadata" ], "default": "blueprint.GeneratedObjectMetadata", "x-enum-as-string": true }, "Conditions": { "type": "array", "items": { "description": "The conditions that must be satisfied for this object to be generated.", "type": "string", "x-omitempty": true }, "nullable": true }, "Name": { "description": "Name for the generated object. The name given for reference in later parts of the blueprint definition. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_). The first and last character in name must be an alphanumeric character.", "type": "string", "pattern": "^[a-zA-Z0-9]+([a-zA-Z0-9-_]*[a-zA-Z0-9])*$", "minLength": 1, "maxLength": 92, "x-omitempty": true }, "ObjectIteration": { "description": "A template for controlling loop behavior when generating multiple instances of the generated object. The resolved value of the template is expected to be an integer which is used to determine the number of iterations in the loop. Each iteration creates a new instance of the generated object.", "type": "string", "x-omitempty": true }, "ObjectSource": { "description": "The source object from which the object is generated.", "$ref": "#/components/schemas/blueprint.BaseGeneratedObjectSourceMetadata", "x-omitempty": true }, "PreGenerateOperations": { "type": "array", "items": { "description": "A set of MO operations to be executed before generating the object. The operations are executed in the order they are defined. The operations can be used to update or delete existing objects before generating the new object.", "$ref": "#/components/schemas/blueprint.PreGenerateOperation", "x-omitempty": true }, "nullable": true }, "PropertyIteration": { "type": "array", "items": { "description": "A template for controlling loop behavior in array properties in the generated object. The size of the input array is used to control the number of iterations when creating the values for the property.", "$ref": "#/components/schemas/blueprint.PropertyIteration", "x-omitempty": true }, "nullable": true }, "PropertyParameters": { "description": "A list of key value pairs where key is the property path and value is the template to derive the value.", "x-omitempty": true }, "Required": { "description": "The flag to indicate if this object must be generated for this blueprint.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "blueprint.GeneratedObjectNew": { "title": "Blueprint:Generated Object New", "description": "Type to capture complete details of how the new object is generated.", "x-allOf-name": "blueprint.GeneratedObjectNew", "allOf": [ { "$ref": "#/components/schemas/blueprint.BaseGeneratedObjectSourceMetadata" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.GeneratedObjectNew', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.GeneratedObjectNew" ], "default": "blueprint.GeneratedObjectNew", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.GeneratedObjectNew" ], "default": "blueprint.GeneratedObjectNew", "x-enum-as-string": true }, "Collection": { "description": "The flag to indicate that a collection of objects will be created based on an array input.", "type": "boolean", "default": false, "x-omitempty": true }, "CreateObjectType": { "description": "The type of the object being created new.", "type": "string", "x-omitempty": true } } } ] }, "blueprint.GeneratedObjectOperationTarget": { "title": "Blueprint:Generated Object Operation Target", "description": "The target of a pre-generation operation performed before an object is generated.", "x-allOf-name": "blueprint.GeneratedObjectOperationTarget", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.GeneratedObjectOperationTarget', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.GeneratedObjectOperationTarget" ], "default": "blueprint.GeneratedObjectOperationTarget", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.GeneratedObjectOperationTarget" ], "default": "blueprint.GeneratedObjectOperationTarget", "x-enum-as-string": true }, "Name": { "description": "The name of the generated object metadata. The objects produced from this metadata are the target of the operation.", "type": "string", "x-omitempty": true }, "PropertyParameters": { "description": "A list of key value pairs where key is the property path and value is the template to derive the value. The target of the pre-generation operation is updated with the resolved values of these parameters. This operation is only applicable if the operation is of type \"Update\".", "x-omitempty": true } } } ] }, "blueprint.GeneratedObjectSourceClone": { "title": "Blueprint:Generated Object Source Clone", "description": "Type to capture complete details of how the source object is provided.", "x-allOf-name": "blueprint.GeneratedObjectSourceClone", "allOf": [ { "$ref": "#/components/schemas/blueprint.BaseGeneratedObjectSourceFromSelector" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.GeneratedObjectSourceClone', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.GeneratedObjectSourceClone" ], "default": "blueprint.GeneratedObjectSourceClone", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.GeneratedObjectSourceClone" ], "default": "blueprint.GeneratedObjectSourceClone", "x-enum-as-string": true }, "CloneType": { "description": "The type of the source object.\n* `Clone` - The generated object will cloned from the given source object.\n* `DeepClone` - The generated object will deep cloned from the given source object. This means the object referenced in the source object will also be cloned.", "type": "string", "enum": [ "Clone", "DeepClone" ], "default": "Clone", "x-omitempty": true } } } ] }, "blueprint.GeneratedObjectSourceLookup": { "title": "Blueprint:Generated Object Source Lookup", "description": "Type to capture complete details of how the source object is provided.", "x-allOf-name": "blueprint.GeneratedObjectSourceLookup", "allOf": [ { "$ref": "#/components/schemas/blueprint.BaseGeneratedObjectSourceFromSelector" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.GeneratedObjectSourceLookup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.GeneratedObjectSourceLookup" ], "default": "blueprint.GeneratedObjectSourceLookup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.GeneratedObjectSourceLookup" ], "default": "blueprint.GeneratedObjectSourceLookup", "x-enum-as-string": true }, "LookupType": { "description": "The type of the object being looked up.\n* `Cloned` - The generated object that is being looked up is a result of a deep clone from a previous step.\n* `PreCreated` - The generated object that is being looked up is an existing or pre-created object from the system catalog or from the user account.", "type": "string", "enum": [ "Cloned", "PreCreated" ], "default": "Cloned", "x-omitempty": true } } } ] }, "blueprint.GeneratedObjectSourceMerge": { "title": "Blueprint:Generated Object Source Merge", "description": "The metadata for performing a merge operation between a source object and one or more targets. The merge operation can be a strict merge, in which empty properties are not copied to the target objects, or a replace operation, in which all properties are replaced.", "x-allOf-name": "blueprint.GeneratedObjectSourceMerge", "allOf": [ { "$ref": "#/components/schemas/blueprint.BaseGeneratedObjectSourceFromSelector" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.GeneratedObjectSourceMerge', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.GeneratedObjectSourceMerge" ], "default": "blueprint.GeneratedObjectSourceMerge", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.GeneratedObjectSourceMerge" ], "default": "blueprint.GeneratedObjectSourceMerge", "x-enum-as-string": true }, "MergeAction": { "description": "The action to be performed when merging the source object with the target object. When the action is set to \"Merge\", all empty source properties are ignored. \"Replace\" action replaces all properties in the target object with the source object properties.\n* `Merge` - The null properties/relationships of the source MO will be ignored for the target MO. The non-null properties/relationships of the source will override the target MO properties/relationships.\n* `Replace` - Merge action as described in RFC 7386. The null properties/relationships of the source MO will be deleted on the target MO.The non-null properties/relationships of the source will override the target MO properties/relationships.When source object type is different from target, only the properties common to both source and target will be affected.Other properties on the target will be ignored.", "type": "string", "enum": [ "Merge", "Replace" ], "default": "Merge", "x-omitempty": true } } } ] }, "blueprint.GeneratedObjectSourceReference": { "title": "Blueprint:Generated Object Source Reference", "description": "Type to capture complete details of how the source object is provided.", "x-allOf-name": "blueprint.GeneratedObjectSourceReference", "allOf": [ { "$ref": "#/components/schemas/blueprint.BaseGeneratedObjectSourceMetadata" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.GeneratedObjectSourceReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.GeneratedObjectSourceReference" ], "default": "blueprint.GeneratedObjectSourceReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.GeneratedObjectSourceReference" ], "default": "blueprint.GeneratedObjectSourceReference", "x-enum-as-string": true }, "SourceParameter": { "description": "When the source object is of type reference, then the source parameter will be the parameter that refers to the source object.", "type": "string", "x-omitempty": true } } } ] }, "blueprint.GeneratedObjectSourceSelector": { "title": "Blueprint:Generated Object Source Selector", "description": "Type to capture the source object selector details.", "x-allOf-name": "blueprint.GeneratedObjectSourceSelector", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.GeneratedObjectSourceSelector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.GeneratedObjectSourceSelector" ], "default": "blueprint.GeneratedObjectSourceSelector", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.GeneratedObjectSourceSelector" ], "default": "blueprint.GeneratedObjectSourceSelector", "x-enum-as-string": true }, "Selector": { "description": "The selector to identify the source object.", "type": "string", "pattern": "^$|/api/v1/.*", "x-omitempty": true } } } ] }, "blueprint.InputOperationType": { "title": "Blueprint:Input Operation Type", "description": "Type to capture the operation details for the input.", "x-allOf-name": "blueprint.InputOperationType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.InputOperationType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.InputOperationType" ], "default": "blueprint.InputOperationType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.InputOperationType" ], "default": "blueprint.InputOperationType", "x-enum-as-string": true }, "ImpactType": { "type": "array", "items": { "description": "The impact of the input change.\n* `None` - Default value is none, indicating no impact.\n* `Reboot` - The input change requires a reboot.", "type": "string", "enum": [ "None", "Reboot" ], "default": "None", "x-omitempty": true }, "nullable": true }, "Name": { "description": "The name of the input as defined within the definition.", "type": "string", "x-omitempty": true }, "OperationModes": { "type": "array", "items": { "description": "The operation modes for the input.\n* `InitialDeployment` - The input is used only for initial deployment.\n* `PostDeployment` - The input is used after deployment.", "type": "string", "enum": [ "InitialDeployment", "PostDeployment" ], "default": "InitialDeployment", "x-omitempty": true }, "nullable": true } } } ] }, "blueprint.PreGenerateOperation": { "title": "Blueprint:Pre Generate Operation", "description": "A set of MO operations to be executed before generating the object. The operations are run prior to object generation and can be used to perform additional cleanup or business logic before the object is generated.", "x-allOf-name": "blueprint.PreGenerateOperation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.PreGenerateOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.PreGenerateOperation" ], "default": "blueprint.PreGenerateOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.PreGenerateOperation" ], "default": "blueprint.PreGenerateOperation", "x-enum-as-string": true }, "GeneratedObjects": { "type": "array", "items": { "description": "The previously generated objects on which the operation is performed.", "$ref": "#/components/schemas/blueprint.GeneratedObjectOperationTarget", "x-omitempty": true }, "nullable": true }, "Operation": { "description": "The operation to be performed before generating the object.\n* `Update` - The operation is to update the object via an HTTP PATCH operation.\n* `Delete` - The operation is to immediately delete the object via an HTTP DELETE operation.\n* `MarkDeleted` - The object is marked as deleted. This adds a tag to the object indicating that it should be deleted as part of the object cleanup task during workload deployment.", "type": "string", "enum": [ "Update", "Delete", "MarkDeleted" ], "default": "Update", "x-omitempty": true } } } ] }, "blueprint.PropertyIteration": { "title": "Blueprint:Property Iteration", "description": "The input to control loop iterations when deriving array properties in a generated object.", "x-allOf-name": "blueprint.PropertyIteration", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.PropertyIteration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.PropertyIteration" ], "default": "blueprint.PropertyIteration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.PropertyIteration" ], "default": "blueprint.PropertyIteration", "x-enum-as-string": true }, "Iteration": { "description": "The expression to evaluate for each iteration. This expression can refer to the array input that is being iterated over. The value of this expression will be used to populate the array property in the generated object.", "type": "string", "x-omitempty": true }, "Name": { "description": "The name of the array property in the generated object to populate.", "type": "string", "x-omitempty": true } } } ] }, "blueprint.ResourceConstraints": { "title": "Blueprint:Resource Constraints", "description": "Type to capture the resource constraints for the blueprints.", "x-allOf-name": "blueprint.ResourceConstraints", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.ResourceConstraints', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.ResourceConstraints" ], "default": "blueprint.ResourceConstraints", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.ResourceConstraints" ], "default": "blueprint.ResourceConstraints", "x-enum-as-string": true }, "InputDefinition": { "type": "array", "items": { "description": "The input definition for the resource constraints that can be provided in the blueprint definition.", "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.BaseDataType", "x-omitempty": true }, "nullable": true } } } ] }, "blueprint.ServiceItemDefinition": { "title": "Blueprint:Service Item Definition", "description": "Definition to capture the service item that is being referred in this blueprint.", "x-allOf-name": "blueprint.ServiceItemDefinition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'blueprint.ServiceItemDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "blueprint.ServiceItemDefinition" ], "default": "blueprint.ServiceItemDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "blueprint.ServiceItemDefinition" ], "default": "blueprint.ServiceItemDefinition", "x-enum-as-string": true }, "CatalogMoid": { "description": "Specify the catalog moid that this service item belongs. When catalog moid is not specified then the catalog of the service item is used first and if no service item can be found in that catalog, then the system catalog is used.", "type": "string", "x-omitempty": true }, "Description": { "description": "The description of that describes the purpose of including this service item within the blueprint.", "type": "string", "x-omitempty": true }, "InputParameters": { "description": "Capture the mapping of blueprint inputs to service item inputs. The mapping for inputs can refer to blueprint inputs or to the generated objects which are part of this blueprint and all nested blueprints. The mapping will be referred using the convention of ${.input.} or ${.generatedObject.}.", "x-omitempty": true }, "Label": { "description": "A user defined label identifier for this Service item.", "type": "string", "x-omitempty": true }, "ServiceItemDefinitionName": { "description": "The qualified name of service item that should be executed.", "type": "string", "x-omitempty": true }, "Version": { "description": "The service item definition version. If not specified, the default version of the service item is used.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "bulk.ApiResult": { "title": "Bulk:Api Result", "description": "The result of an individual REST API action.", "x-allOf-name": "bulk.ApiResult", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.ApiResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "bulk.RestResult" ], "default": "bulk.RestResult", "x-enum-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": [ "bulk.RestResult" ], "default": "bulk.RestResult", "x-enum-as-string": true }, "Status": { "description": "The http return status of the individual API action.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "bulk.BaseExport.Relationship": { "description": "A relationship to the 'bulk.BaseExport' resource, or the expanded 'bulk.BaseExport' resource, or the 'null' value.", "x-one-of-name": "bulk.BaseExport.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.BaseExport" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.BaseExport": { "title": "Bulk:Base Export", "description": "The Export MO is the top level MO that is created by the user to represent an export operation and \nthis abstract MO is used to hold references of concrete gingerbread export MOs in barcelona export\nrelated MOs.", "x-allOf-name": "bulk.BaseExport", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" } ] }, "bulk.Export.Response": { "description": "The response body of a HTTP GET request for the 'bulk.Export' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bulk.Export' resources.", "x-one-of-name": "bulk.Export.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bulk.Export.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bulk.Export.Relationship": { "description": "A relationship to the 'bulk.Export' resource, or the expanded 'bulk.Export' resource, or the 'null' value.", "x-one-of-name": "bulk.Export.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.Export" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.Export": { "title": "Bulk:Export", "description": "The Export object is integral to managing export operations within the system, providing a structured approach to monitor and control various aspects of data exporting activities.\n#### Purpose\nThe Export object tracks the progress and status of data export operations. It serves as the main point of reference for users who need to initiate, manage, or terminate export processes efficiently.\n#### Key Concepts\n- **Operation Tracking:** Captures all export activities as instances, allowing users to monitor status updates and completion metrics.\n- **Privilege Management:** Enforces access control through privilege sets, ensuring only authorized users can initiate, update, or delete export processes.\n- **Action Flexibility:** Supports actions such as starting or canceling an export, giving users control over operation flow.\n- **Organizational Ownership:** Reflects ownership and management by the organization, promoting structured and accountable export operations.", "x-allOf-name": "bulk.Export", "allOf": [ { "$ref": "#/components/schemas/bulk.BaseExport" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.Export', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.Export" ], "default": "bulk.Export", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.Export" ], "default": "bulk.Export", "x-enum-as-string": true }, "Action": { "description": "Action to be performed on the export operation.\n* `Start` - Starts the export operation.\n* `Cancel` - Cancels the export operation that is in progress.", "type": "string", "enum": [ "Start", "Cancel" ], "default": "Start", "x-omitempty": true }, "ExcludePeers": { "type": "array", "items": { "description": "List of relationships for which the peer objects should not be exported. Note that the relationship properties themselves would be exported and only the peer objects would not be exported. This specification would not be used if 'excludeRelations' is enabled since that would exclude the export of relationship values themselves.", "type": "string", "x-omitempty": true }, "nullable": true }, "ExcludeRelations": { "description": "Used to specify that none of the relationships should be exported.", "type": "boolean", "x-omitempty": true }, "ExportTags": { "description": "Specifies whether tags must be exported and will be considered for all the items MOs.", "type": "boolean", "default": true, "x-createOnly": true, "x-omitempty": true }, "ExportedObjects": { "type": "array", "items": { "description": "Contents of all the items exported.", "$ref": "#/components/schemas/bulk.SubRequest", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExportedObjectsAsGroups": { "type": "array", "items": { "description": "Contents of all the items exported as multiple group of sub requests where each group can be imported in a single bulk request.\nThis is populated only when the splitRequests flag is set in the export operation.", "$ref": "#/components/schemas/bulk.SubRequestsGroup", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ImportOrder": { "description": "Contains the list of import order. This field is deprecated and will be removed in future versions.", "deprecated": true, "x-sunset": "2027-04-01", "nullable": true, "readOnly": true, "x-omitempty": true }, "IncludeOrgIdentity": { "description": "Indicates that exported references for objects which are organization owned should include the organization reference along with the other identity properties.", "type": "boolean", "x-omitempty": true }, "IsAesKeySet": { "description": "Indicates whether the value of the 'aesKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "ItemNames": { "type": "array", "items": { "description": "Names of all the items to be exported. It will further be used to populate the export summary.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "Items": { "type": "array", "items": { "description": "List of MOs to be exported.", "$ref": "#/components/schemas/mo.MoRef", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "An identifier for the export instance. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_).", "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]{1,255}$", "x-createOnly": true, "x-omitempty": true }, "PermissionId": { "description": "The permission identifier which indicates the permission that current user has that will allow to start this export operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "PreserveIdentities": { "description": "The flag set by the user during a configuration backup to preserve static or dynamic IDs assigned to an export item.", "type": "boolean", "x-omitempty": true }, "RelatedTypeOptions": { "type": "array", "items": { "description": "Options to be used when instances of related types are exported during this export operation.", "$ref": "#/components/schemas/bulk.RelatedTypeExportOption", "x-omitempty": true }, "nullable": true }, "SplitRequests": { "description": "Intersight supports the import operation using bulk requests. A single bulk request is created using the bulk sub\nrequests created in export operation. There is a restriction of a single API request size in Intersight.\nIf the exported MOs are many in an export operation, this flag will store the bulk sub requests as two dimensional\ncollection property exportedObjectsAsGroups instead of one dimensional exportedObjects value where the sub requests are split into multiple smaller\ngroups. Each group can be sent in a single bulk request during import operation.", "type": "boolean", "x-createOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the export operation.\n* `` - The operation has not started.\n* `InProgress` - The operation is in progress.\n* `OrderInProgress` - The archive operation is in progress.\n* `Success` - The operation has succeeded.\n* `Failed` - The operation has failed.\n* `OperationTimedOut` - The operation has timed out.\n* `OperationCancelled` - The operation has been cancelled.\n* `CancelInProgress` - The operation is being cancelled.", "type": "string", "enum": [ "", "InProgress", "OrderInProgress", "Success", "Failed", "OperationTimedOut", "OperationCancelled", "CancelInProgress" ], "default": "", "readOnly": true, "x-omitempty": true }, "StatusMessage": { "description": "Status message associated with failures or progress indication.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserId": { "description": "The user identifier which indicates the user that started this export operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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.", "x-createOnly": true }, "ExportedItems": { "deprecated": true, "x-sunset": "2027-04-01", "description": "An array of relationships to bulkExportedItem resources.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.ExportedItem.Relationship" }, "nullable": true, "readOnly": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IdpReference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "#/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 }, "User": { "$ref": "#/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." } } } ] }, "bulk.Export.List": { "title": "List of 'bulk.Export' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bulk.Export' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bulk.Export' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.Export" }, "nullable": true } } } ] }, "bulk.ExportedItem.Response": { "description": "The response body of a HTTP GET request for the 'bulk.ExportedItem' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bulk.ExportedItem' resources.", "x-one-of-name": "bulk.ExportedItem.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bulk.ExportedItem.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bulk.ExportedItem.Relationship": { "description": "A relationship to the 'bulk.ExportedItem' resource, or the expanded 'bulk.ExportedItem' resource, or the 'null' value.", "x-one-of-name": "bulk.ExportedItem.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.ExportedItem" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.ExportedItem": { "title": "Bulk:Exported Item", "description": "A single managed object that is being exported.", "x-allOf-name": "bulk.ExportedItem", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.ExportedItem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.ExportedItem" ], "default": "bulk.ExportedItem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.ExportedItem" ], "default": "bulk.ExportedItem", "x-enum-as-string": true }, "ExcludePeers": { "type": "array", "items": { "description": "List of relationships for which the peer objects should not be exported.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExcludeRelations": { "description": "Do not export relationships.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ExportTags": { "description": "Specifies whether tags must be exported for item MO.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "FileName": { "description": "Name of the file corresponding to item MO.", "type": "string", "readOnly": true, "x-omitempty": true }, "IncludeOrgIdentity": { "description": "Indicates that exported references for objects which are organization owned should include the organization reference along with the other identity properties.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsAesKeySet": { "description": "Indicates whether the value of the 'aesKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Item": { "description": "Identity of the MO that is being exported.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Name": { "description": "MO item identity (the moref corresponding to item) expressed as a string.", "type": "string", "readOnly": true, "x-omitempty": true }, "RelatedTypeOptions": { "type": "array", "items": { "description": "Options to be used when instances of related types are exported.", "$ref": "#/components/schemas/bulk.RelatedTypeExportOption", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ServiceName": { "description": "Name of the target service that owns the item MO. Service responsible for handling exported item mo notifications.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceVersion": { "description": "Version of the service that owns the item MO.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the item's export operation.\n* `` - The operation has not started.\n* `Ready` - The operation is ready to start.\n* `ValidationInProgress` - The validation operation is in progress.\n* `Valid` - The content to be imported is valid.\n* `InValid` - The content to be imported is not valid and the status message will have the reason.\n* `InProgress` - The operation is in progress.\n* `Success` - The operation has succeeded.\n* `Failed` - The operation has failed.\n* `RollBackInitiated` - The rollback has been initiated for import failure.\n* `RollBackFailed` - The rollback has failed for import failure.\n* `RollbackCompleted` - The rollback has completed for import failure.\n* `RollbackAborted` - The rollback has been aborted for import failure.\n* `OperationTimedOut` - The operation has timed out.\n* `OperationCancelled` - The operation has been canceled.\n* `CancelInProgress` - The operation is being canceled.", "type": "string", "enum": [ "", "Ready", "ValidationInProgress", "Valid", "InValid", "InProgress", "Success", "Failed", "RollBackInitiated", "RollBackFailed", "RollbackCompleted", "RollbackAborted", "OperationTimedOut", "OperationCancelled", "CancelInProgress" ], "default": "", "readOnly": true, "x-omitempty": true }, "StatusMessage": { "description": "Progress or error message for the MO's export operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Export": { "$ref": "#/components/schemas/bulk.BaseExport.Relationship", "description": "A reference to a bulkBaseExport resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ParentItem": { "$ref": "#/components/schemas/bulk.ExportedItem.Relationship", "description": "A reference to a bulkExportedItem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RelatedItems": { "description": "An array of relationships to bulkExportedItem resources.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.ExportedItem.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "bulk.ExportedItem.List": { "title": "List of 'bulk.ExportedItem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bulk.ExportedItem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bulk.ExportedItem' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.ExportedItem" }, "nullable": true } } } ] }, "bulk.HttpHeader": { "title": "Bulk:Http Header", "description": "The HttpHeader object represents an HTTP header within the context of API operations. It is used to specify metadata in the form of key-value pairs accompanying HTTP requests and responses. \n#### Purpose \nThe HttpHeader object is fundamental to HTTP communication, allowing for customization and specification of additional information that can influence how requests are processed and responses are interpreted. It serves as a mechanism for transmitting metadata related to the request or response. \n#### Key Concepts\n- **Metadata Transmission:** Facilitates the conveyance of important metadata between client and server, including content type, authentication details, and other request-specific information. \n- **Standardization:** Provides a standardized format for HTTP headers, ensuring consistent handling across various API endpoints. \n- **Read-Only Access:** Designed to be immutable post-creation, ensuring the integrity of header information during API transactions. \n- **Integration:** Used across various API requests to enhance functionality and optimize communication between systems.", "x-allOf-name": "bulk.HttpHeader", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.HttpHeader', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.HttpHeader" ], "default": "bulk.HttpHeader", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.HttpHeader" ], "default": "bulk.HttpHeader", "x-enum-as-string": true }, "Name": { "description": "The name of the http header.", "type": "string", "readOnly": true, "x-omitempty": true }, "Value": { "description": "The value of the http header.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "bulk.MoCloner.Response": { "description": "The response body of a HTTP GET request for the 'bulk.MoCloner' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bulk.MoCloner' resources.", "x-one-of-name": "bulk.MoCloner.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bulk.MoCloner.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bulk.MoCloner.Relationship": { "description": "A relationship to the 'bulk.MoCloner' resource, or the expanded 'bulk.MoCloner' resource, or the 'null' value.", "x-one-of-name": "bulk.MoCloner.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.MoCloner" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.MoCloner": { "title": "Bulk:Mo Cloner", "description": "The MoCloner object is an interface designed to facilitate the cloning of managed objects (MOs) in bulk operations. It enables the creation of multiple copies of a specified resource instance. \n#### Purpose\nMoCloner is used primarily for template derivation operations, allowing users to replicate existing templates into new derived instances while applying specific overrides to identity properties or other configurations. \n#### Key Concepts\n- **Bulk Cloning:** Supports the generation of multiple clones in a single operation, optimizing resource duplication processes. \n- **Template Derivation:** Facilitates the derivation of server profiles, vNIC templates, and vHBA templates, ensuring consistency across cloned instances. \n- **Configuration Override:** Allows for customization of cloned instances by specifying new values for identity and other properties. \n- **Async Processing:** Supports asynchronous operation, enabling efficient handling of large-scale cloning tasks.", "x-allOf-name": "bulk.MoCloner", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.MoCloner', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.MoCloner" ], "default": "bulk.MoCloner", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.MoCloner" ], "default": "bulk.MoCloner", "x-enum-as-string": true }, "ExcludeProperties": { "type": "array", "items": { "description": "List of the source MO property names to be excluded from the clone operation.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "Responses": { "type": "array", "items": { "description": "List of success/failure response of each of the individual MO POST/PATCH operations generated as part of this bulk request.", "$ref": "#/components/schemas/bulk.RestResult", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Sources": { "type": "array", "items": { "description": "Array of Identifiers of the source instances (MoRefs).", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "Targets": { "type": "array", "items": { "description": "Array of MOs to be cloned. Each array item is a JSON document in JSON merge patch format (RFC 7386).", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "WorkflowNameSuffix": { "description": "A user-friendly short name to identify the workflow. Name can only contain letters (a-z, A-Z),\nnumbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), comma or an underscore (_).", "type": "string", "pattern": "^$|^[a-zA-Z0-9]{1}[\\sa-zA-Z0-9_.\\,/:-]{0,63}$", "x-createOnly": true, "x-omitempty": true }, "AsyncResult": { "$ref": "#/components/schemas/bulk.Result.Relationship", "description": "A reference to a bulkResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "#/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 } } } ] }, "bulk.MoCloner.List": { "title": "List of 'bulk.MoCloner' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bulk.MoCloner' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bulk.MoCloner' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.MoCloner" }, "nullable": true } } } ] }, "bulk.MoDeepCloner.Response": { "description": "The response body of a HTTP GET request for the 'bulk.MoDeepCloner' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bulk.MoDeepCloner' resources.", "x-one-of-name": "bulk.MoDeepCloner.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bulk.MoDeepCloner.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bulk.MoDeepCloner.Relationship": { "description": "A relationship to the 'bulk.MoDeepCloner' resource, or the expanded 'bulk.MoDeepCloner' resource, or the 'null' value.", "x-one-of-name": "bulk.MoDeepCloner.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.MoDeepCloner" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.MoDeepCloner": { "title": "Bulk:Mo Deep Cloner", "description": "The MoDeepCloner object is an advanced cloning interface that enables deep copies of managed objects (MOs). It supports the replication of complex structures with nested relationships. \n#### Purpose\nMoDeepCloner provides enhanced cloning capabilities beyond shallow copies, enabling the duplication of intricate MO structures for scenarios requiring comprehensive data replication. \n#### Key Concepts\n- **Deep Copying:** Facilitates the replication of entire MO structures, preserving nested relationships and dependencies within the cloned instances. \u00a0\n- **Customization:** Allows for the specification of identity and configuration overrides, ensuring each clone meets specific requirements.\n- **Reference Handling:** Offers options for managing references during cloning, including creating new references or preserving existing ones. \n- **Async Operation:** Supports only asynchronous processing, enabling efficient handling of complex cloning tasks with minimal performance impact.", "x-allOf-name": "bulk.MoDeepCloner", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.MoDeepCloner', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.MoDeepCloner" ], "default": "bulk.MoDeepCloner", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.MoDeepCloner" ], "default": "bulk.MoDeepCloner", "x-enum-as-string": true }, "ExcludeProperties": { "type": "array", "items": { "description": "List of the source MO property names to be excluded from the clone operation.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "ReferenceNameSuffix": { "description": "Name suffix to be applied to all the MOs being cloned when ReferencePolicy chosen is CreateNew. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-) or an underscore (_).", "type": "string", "pattern": "^$|^[a-zA-Z0-9_-]{1,64}$", "x-omitempty": true }, "ReferencePolicy": { "description": "User selected reference clone behavior. Applies to all the MOs being cloned.\n* `ReuseAll` - Any policies in the destination organization whose name matches the policy referenced in the cloned policy will be attached. If no policyin the destination organization matches by name, a policy will be cloned with the same name.Pool references will always be matched by name. If not found, the pool will be cloned in the destination organization, but no identifierblocks will be created.\n* `CreateNew` - New policies will be created for the source and all the attached policies. If a policy of the same name and type already exists in thedestination organization or any organization from which it shares policies, a clone will be created with the provided suffix added to the name.Pool references will always be matched by name. If not found, the pool will be cloned in the destination organization, but no identifierblocks will be created.", "type": "string", "enum": [ "ReuseAll", "CreateNew" ], "default": "ReuseAll", "x-omitempty": true }, "Source": { "description": "MoRef of the source instance.", "$ref": "#/components/schemas/mo.MoRef", "x-createOnly": true, "x-omitempty": true }, "Targets": { "type": "array", "items": { "description": "Array of MOs to be cloned. Each array item is a JSON document in JSON merge patch format (RFC 7386).", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "WorkflowNameSuffix": { "description": "A user-friendly short name to identify the workflow. Name can only contain letters (a-z, A-Z),\nnumbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), comma or an underscore (_).", "type": "string", "pattern": "^$|^[a-zA-Z0-9]{1}[\\sa-zA-Z0-9_.\\,/:-]{0,63}$", "x-createOnly": true, "x-omitempty": true }, "AsyncResult": { "$ref": "#/components/schemas/bulk.Result.Relationship", "description": "A reference to a bulkResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "#/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 } } } ] }, "bulk.MoDeepCloner.List": { "title": "List of 'bulk.MoDeepCloner' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bulk.MoDeepCloner' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bulk.MoDeepCloner' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.MoDeepCloner" }, "nullable": true } } } ] }, "bulk.MoMerger.Response": { "description": "The response body of a HTTP GET request for the 'bulk.MoMerger' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bulk.MoMerger' resources.", "x-one-of-name": "bulk.MoMerger.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bulk.MoMerger.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bulk.MoMerger.Relationship": { "description": "A relationship to the 'bulk.MoMerger' resource, or the expanded 'bulk.MoMerger' resource, or the 'null' value.", "x-one-of-name": "bulk.MoMerger.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.MoMerger" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.MoMerger": { "title": "Bulk:Mo Merger", "description": "The MoMerger object is an interface designed to merge properties of managed object (MO) instances. It allows for the synchronization and updating of multiple target MOs based on specified source configurations. \n#### Purpose\nMoMerger is instrumental in template synchronization, enabling bulk updates of derived instances with changes made to their parent templates, ensuring consistency across configurations. \n#### Key Concepts\n- **Property Merging:** Supports the merging of selected properties from source to target instances, allowing for efficient updates and configuration synchronization. \n- **Template Synchronization:** Facilitates the propagation of template changes to derived profiles, ensuring uniformity and adherence to updated configurations. \n- **Configuration Application:** Offers the ability to apply specific configuration changes across all target instances during the merge process. \n- **Async Processing:** Operates asynchronously, accommodating large-scale merge operations without impacting system performance.", "x-allOf-name": "bulk.MoMerger", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.MoMerger', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.MoMerger" ], "default": "bulk.MoMerger", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.MoMerger" ], "default": "bulk.MoMerger", "x-enum-as-string": true }, "MergeAction": { "description": "The type of merge action to be applied on the target MOs. \n* `Merge` - The null properties/relationships of the source MO will be ignored for the target MO. The non-null properties/relationships of the source will override the target MO properties/relationships.\n* `Replace` - Merge action as described in RFC 7386. The null properties/relationships of the source MO will be deleted on the target MO.The non-null properties/relationships of the source will override the target MO properties/relationships.When source object type is different from target, only the properties common to both source and target will be affected.Other properties on the target will be ignored.", "type": "string", "enum": [ "Merge", "Replace" ], "default": "Merge", "x-createOnly": true, "x-omitempty": true }, "Responses": { "type": "array", "items": { "description": "The object describes the success/failure response of each of the individual MO POST/PATCH operations generated as part of this bulk request.", "$ref": "#/components/schemas/bulk.RestResult", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Sources": { "type": "array", "items": { "description": "Array of source MO instances (MoRef).", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "TargetConfig": { "description": "JSON document specifying the configuration, if applicable, to be applied on all the target MOs.", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "Targets": { "type": "array", "items": { "description": "Array of target MO instances (MoRef).", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "WorkflowNameSuffix": { "description": "A user-friendly short name to identify the workflow. Name can only contain letters (a-z, A-Z),\nnumbers (0-9), hyphen (-), period (.), colon (:), space ( ), forward slash (/), comma or an underscore (_).", "type": "string", "pattern": "^$|^[a-zA-Z0-9]{1}[\\sa-zA-Z0-9_.\\,/:-]{0,63}$", "x-createOnly": true, "x-omitempty": true }, "AsyncResult": { "$ref": "#/components/schemas/bulk.Result.Relationship", "description": "A reference to a bulkResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "#/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 } } } ] }, "bulk.MoMerger.List": { "title": "List of 'bulk.MoMerger' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bulk.MoMerger' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bulk.MoMerger' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.MoMerger" }, "nullable": true } } } ] }, "bulk.MultiRelationEntryPatch": { "title": "Bulk:Multi Relation Entry Patch", "description": "Internal type to enable patching of a multi relationship entry during MO clone.", "x-allOf-name": "bulk.MultiRelationEntryPatch", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "bulk.PatchContent": { "title": "Bulk:Patch Content", "description": "Object that is used for patching a document.", "x-allOf-name": "bulk.PatchContent", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "bulk.RelatedTypeExportOption": { "title": "Bulk:Related Type Export Option", "description": "Options to be used when instances of a related type are exported during an export operation.", "x-allOf-name": "bulk.RelatedTypeExportOption", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.RelatedTypeExportOption', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.RelatedTypeExportOption" ], "default": "bulk.RelatedTypeExportOption", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.RelatedTypeExportOption" ], "default": "bulk.RelatedTypeExportOption", "x-enum-as-string": true }, "ExcludeRelations": { "description": "Do not export relationships.", "type": "boolean", "x-omitempty": true }, "ExcludedPeers": { "type": "array", "items": { "description": "List of relationships for which the peer objects should not be exported.", "type": "string", "x-omitempty": true }, "nullable": true }, "RelatedType": { "description": "The fully qualified related type name.", "type": "string", "x-omitempty": true } } } ] }, "bulk.Request.Response": { "description": "The response body of a HTTP GET request for the 'bulk.Request' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bulk.Request' resources.", "x-one-of-name": "bulk.Request.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bulk.Request.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bulk.Request.Relationship": { "description": "A relationship to the 'bulk.Request' resource, or the expanded 'bulk.Request' resource, or the 'null' value.", "x-one-of-name": "bulk.Request.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.Request" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.Request": { "title": "Bulk:Request", "description": "Requests (bulk.Request) represent a bulk-operation submission that allows clients to execute multiple API actions\u2014such as Create, Update, or Delete\u2014against a given base URI, including operations across multiple subpaths relative to that URI. The object is designed for high-volume changes with optional asynchronous response handling.\n#### Purpose\nEnable efficient, controlled execution of many related API changes in a single bulk request, reducing client-side overhead and supporting consistent execution semantics for batch create/update/delete workflows.\n#### Key Concepts\n- **Bulk API execution container**: Encapsulates a set of actions (`actions`) that the platform will apply in bulk relative to a provided target URI.\n- **Multi-subpath operations**: Supports acting on multiple objects/resources under the same REST resource type (e.g., PATCH multiple objects of a type).\n- **Action semantics and pre-checks**: `actions` describe what should be done, and can include behavior such as checking for existence vs executing changes (as described in the model).\n- **Asynchronous support**: CREATE supports `respond-async: true`, allowing clients to request async processing suitable for large batches.\n- **Create-only action definition**: `actions` is `createonly`, preserving the integrity of what was submitted once the bulk request is created.\n- **Global privilege gating**: Access is controlled via global privilege sets for READ/CREATE, reflecting the broad impact and cross-resource nature of bulk operations.\n- **Organization-owned request record**: `owner: organization` indicates the bulk request exists within an org/account context even though the privileges are global.", "x-allOf-name": "bulk.Request", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.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": [ "bulk.Request" ], "default": "bulk.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": [ "bulk.Request" ], "default": "bulk.Request", "x-enum-as-string": true }, "ActionOnError": { "description": "The action to be taken when an error occurs during processing of the request.\n* `Stop` - Stop the processing of the request after the first error.\n* `Proceed` - Proceed with the processing of the request even when an error occurs.", "type": "string", "enum": [ "Stop", "Proceed" ], "default": "Stop", "x-createOnly": true, "x-omitempty": true }, "Actions": { "type": "array", "items": { "description": "The type of action for the request.\nThe request can be used to check if the objects in the request are already present or to just execute the request.\n* `CheckObjectPresence` - Check if the objects in the request are already present.\n* `Execute` - Used to specify that the request needs to be validated and executed.", "type": "string", "enum": [ "CheckObjectPresence", "Execute" ], "default": "CheckObjectPresence", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "CompletionTime": { "description": "The timestamp when the request processing completed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Headers": { "type": "array", "items": { "description": "The collection of http headers from the request.", "$ref": "#/components/schemas/bulk.HttpHeader", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsBackupEncryptionKeySet": { "description": "Indicates whether the value of the 'backupEncryptionKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "NumSubRequests": { "description": "The number of sub requests received in this request.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OrgMoid": { "description": "The moid of the organization under which this request was issued.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestReceivedTime": { "description": "The timestamp when the request was received.", "type": "string", "readOnly": true, "x-omitempty": true }, "Requests": { "type": "array", "items": { "description": "Array of individual requests to be executed.", "$ref": "#/components/schemas/bulk.SubRequest", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "Results": { "type": "array", "items": { "description": "The results corresponding to this request. The results are populated when the request preference is sync.", "$ref": "#/components/schemas/bulk.ApiResult", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SkipDuplicates": { "description": "Skip the already present objects.", "type": "boolean", "x-createOnly": true, "x-omitempty": true }, "Status": { "description": "The processing status of the Request.\n* `NotStarted` - Indicates that the request processing has not begun yet.\n* `ObjPresenceCheckInProgress` - Indicates that the object presence check is in progress for this request.\n* `ObjPresenceCheckComplete` - Indicates that the object presence check is complete.\n* `ExecutionInProgress` - Indicates that the request processing is in progress.\n* `Completed` - Indicates that the request processing has been completed successfully.\n* `CompletedWithErrors` - Indicates that the request processing has one or more failed subrequests.\n* `Failed` - Indicates that the processing of this request failed.\n* `TimedOut` - Indicates that the request processing timed out.", "type": "string", "enum": [ "NotStarted", "ObjPresenceCheckInProgress", "ObjPresenceCheckComplete", "ExecutionInProgress", "Completed", "CompletedWithErrors", "Failed", "TimedOut" ], "default": "NotStarted", "readOnly": true, "x-omitempty": true }, "StatusMessage": { "description": "The status message corresponding to the status.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uri": { "description": "The URI on which this bulk action is to be performed.\nThe value will be used when there is no override in the SubRequest.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Verb": { "description": "The type of operation to be performed.\nOne of - Post (Create), Patch (Update) or Delete (Remove).\nThe value will be used when there is no override in the SubRequest.\n* `POST` - Used to create a REST resource.\n* `PATCH` - Used to update a REST resource.\n* `DELETE` - Used to delete a REST resource.", "type": "string", "enum": [ "POST", "PATCH", "DELETE" ], "default": "POST", "x-createOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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.", "x-createOnly": true }, "AsyncResults": { "description": "An array of relationships to bulkSubRequestObj resources.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.SubRequestObj.Relationship" }, "nullable": true, "readOnly": true }, "AsyncResultsFailed": { "description": "An array of relationships to bulkSubRequestObj resources.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.SubRequestObj.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "#/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 }, "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.", "readOnly": true } } } ] }, "bulk.Request.List": { "title": "List of 'bulk.Request' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bulk.Request' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bulk.Request' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.Request" }, "nullable": true } } } ] }, "bulk.RestResult": { "title": "Bulk:Rest Result", "description": "The result of an individual REST API action.", "x-allOf-name": "bulk.RestResult", "allOf": [ { "$ref": "#/components/schemas/bulk.ApiResult" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.RestResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.RestResult" ], "default": "bulk.RestResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.RestResult" ], "default": "bulk.RestResult", "x-enum-as-string": true }, "Body": { "description": "The response for an individual REST API action.", "$ref": "#/components/schemas/mo.BaseMo", "readOnly": true, "x-omitempty": true }, "BodyString": { "description": "The response string for an individual REST API action.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "bulk.RestSubRequest": { "title": "Bulk:Rest Sub Request", "description": "An individual REST API request to be executed as part of a bulk request.", "x-allOf-name": "bulk.RestSubRequest", "allOf": [ { "$ref": "#/components/schemas/bulk.SubRequest" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.RestSubRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.RestSubRequest" ], "default": "bulk.RestSubRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.RestSubRequest" ], "default": "bulk.RestSubRequest", "x-enum-as-string": true }, "Body": { "description": "The content to be used for creating or updating a MO.\nThis field would need to conform to the schema published for the object type that is being operated upon.", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "TargetMoid": { "description": "Used with PATCH & DELETE actions. The moid of an existing object instance.", "type": "string", "x-createOnly": true, "x-omitempty": true } } } ] }, "bulk.Result.Response": { "description": "The response body of a HTTP GET request for the 'bulk.Result' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bulk.Result' resources.", "x-one-of-name": "bulk.Result.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bulk.Result.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bulk.Result.Relationship": { "description": "A relationship to the 'bulk.Result' resource, or the expanded 'bulk.Result' resource, or the 'null' value.", "x-one-of-name": "bulk.Result.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.Result" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.Result": { "title": "Bulk:Result", "description": "The Result object serves as a status-monitoring resource within asynchronous bulk operations. This provides detailed insights into the processing status of bulk API requests. \n#### Purpose \nResult is used to track the progress and outcome of bulk operations, offering transparency and accountability for asynchronous API transactions. \n#### Key Concepts\n- **Status Monitoring:** Provides real-time updates on the processing status of requests, including success, failure, and completion states. \n- **Error Handling:** Captures error details and status messages, facilitating troubleshooting and resolution of failed operations. \n- **Async Support:** Integrates seamlessly with asynchronous workflows, supporting efficient management of large-scale API operations. \n- **Workflow Integration:** Links to workflow objects for comprehensive status tracking and management within automation processes.", "x-allOf-name": "bulk.Result", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.Result', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.Result" ], "default": "bulk.Result", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.Result" ], "default": "bulk.Result", "x-enum-as-string": true }, "ActionOnError": { "description": "The action that will be performed when an error occurs during processing of the request.\n* `Stop` - Stop the processing of the request after the first error.\n* `Proceed` - Proceed with the processing of the request even when an error occurs.", "type": "string", "enum": [ "Stop", "Proceed" ], "default": "Stop", "readOnly": true, "x-omitempty": true }, "CompletionTime": { "description": "The timestamp in UTC when the request processing is completed.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "NumSubRequests": { "description": "The number of subrequests received in this request.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Request": { "description": "The individual request to be executed asynchronously.", "nullable": true, "x-createOnly": true, "x-omitempty": true }, "RequestReceivedTime": { "description": "The timestamp in UTC when the request was received.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The processing status of the request.\n* `NotStarted` - Indicates that the request processing has not begun yet.\n* `ObjPresenceCheckInProgress` - Indicates that the object presence check is in progress for this request.\n* `ObjPresenceCheckComplete` - Indicates that the object presence check is complete.\n* `ExecutionInProgress` - Indicates that the request processing is in progress.\n* `Completed` - Indicates that the request processing has been completed successfully.\n* `CompletedWithErrors` - Indicates that the request processing has one or more failed subrequests.\n* `Failed` - Indicates that the processing of this request failed.\n* `TimedOut` - Indicates that the request processing timed out.", "type": "string", "enum": [ "NotStarted", "ObjPresenceCheckInProgress", "ObjPresenceCheckComplete", "ExecutionInProgress", "Completed", "CompletedWithErrors", "Failed", "TimedOut" ], "default": "NotStarted", "readOnly": true, "x-omitempty": true }, "StatusMessage": { "description": "The status message shows the error details in human readable format when the request goes to failed state. No additional information is shown for success case.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uri": { "description": "The URI on which this async operation is being performed.", "type": "string", "readOnly": true, "x-omitempty": true }, "MoCloner": { "$ref": "#/components/schemas/bulk.MoCloner.Relationship", "description": "A reference to a bulkMoCloner resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MoDeepCloner": { "$ref": "#/components/schemas/bulk.MoDeepCloner.Relationship", "description": "A reference to a bulkMoDeepCloner resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MoMerger": { "$ref": "#/components/schemas/bulk.MoMerger.Relationship", "description": "A reference to a bulkMoMerger resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "#/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 }, "Results": { "description": "An array of relationships to bulkSubRequestObj resources.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.SubRequestObj.Relationship" }, "nullable": true, "readOnly": true }, "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.", "readOnly": true } } } ] }, "bulk.Result.List": { "title": "List of 'bulk.Result' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bulk.Result' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bulk.Result' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.Result" }, "nullable": true } } } ] }, "bulk.SecResourceRoles": { "title": "Bulk:Sec Resource Roles", "description": "Used to store the orgs and their associated roles for a given user permission in the security context.", "x-allOf-name": "bulk.SecResourceRoles", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "bulk.SubRequest": { "title": "Bulk:Sub Request", "description": "An individual API request that is contained within a bulk request.", "x-allOf-name": "bulk.SubRequest", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.SubRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "bulk.RestSubRequest" ], "default": "bulk.RestSubRequest", "x-enum-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": [ "bulk.RestSubRequest" ], "default": "bulk.RestSubRequest", "x-enum-as-string": true }, "Uri": { "description": "The URI on which this action is to be performed.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Verb": { "description": "The type of operation to be performed.\nOne of - Post (Create), Patch (Update) or Delete (Remove).\nThe value is used to override the top level verb.\n* `POST` - Used to create a REST resource.\n* `PATCH` - Used to update a REST resource.\n* `DELETE` - Used to delete a REST resource.", "type": "string", "enum": [ "POST", "PATCH", "DELETE" ], "default": "POST", "x-createOnly": true, "x-omitempty": true } } } ] }, "bulk.SubRequestObj.Response": { "description": "The response body of a HTTP GET request for the 'bulk.SubRequestObj' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bulk.SubRequestObj' resources.", "x-one-of-name": "bulk.SubRequestObj.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bulk.SubRequestObj.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bulk.SubRequestObj.Relationship": { "description": "A relationship to the 'bulk.SubRequestObj' resource, or the expanded 'bulk.SubRequestObj' resource, or the 'null' value.", "x-one-of-name": "bulk.SubRequestObj.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bulk.SubRequestObj" } ], "discriminator": { "propertyName": "ClassId" } }, "bulk.SubRequestObj": { "title": "Bulk:Sub Request Obj", "description": "The SubRequestObj object represents an individual API request processed as part of a larger bulk operation. It serves as an internal record for every sub-request included in an incoming bulk request.\n#### Purpose\nThe SubRequestObj is designed to provide granular tracking and status reporting for each specific operation (Create, Update, or Delete) within a bulk request. It allows the system to manage, monitor, and correlate the execution status of multiple sub-requests, ensuring that each part of a bulk operation is accounted for and processed correctly.\n#### Key Concepts\n- **Request Correlation:** Uses a unique request number to correlate individual sub-requests with their corresponding bulk request and response.\n- **Execution Tracking:** Monitors the lifecycle of each sub-request, including execution start/completion times and current processing status.\n- **Presence Detection:** Includes flags to detect if an object is already present or if a system-defined object has been triggered, supporting idempotent operations.\n- **Result Management:** Stores the outcome of the individual API action, including success or failure details, within the `result` property.\n- **Target Context:** Maintains the target MOID and request body, ensuring that the operation is applied to the correct resource with the intended data payload.", "x-allOf-name": "bulk.SubRequestObj", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.SubRequestObj', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.SubRequestObj" ], "default": "bulk.SubRequestObj", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.SubRequestObj" ], "default": "bulk.SubRequestObj", "x-enum-as-string": true }, "Body": { "description": "The content to be used for creating or updating a MO.\nThis field would need to conform to the schema published for the object type that is being operated upon.", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "BodyString": { "description": "The body of the sub-request in string format.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExecutionCompletionTime": { "description": "The time at which processing of this request completed.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExecutionStartTime": { "description": "The time at which processing of this request started.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsBulkMoOp": { "description": "For Async Bulk Mo Operations this flag will be set to true.", "type": "boolean", "x-createOnly": true, "x-omitempty": true }, "IsObjectPresent": { "description": "This flag indicates if an already existing object was found or not after execution of the action CheckObjectPresence.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Result": { "description": "The result corresponding to this request.", "$ref": "#/components/schemas/bulk.ApiResult", "readOnly": true, "x-omitempty": true }, "SkipDuplicates": { "description": "Skip the already present objects. The value from the Request.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the request.\n* `Pending` - Indicates that the request is yet to be processed.\n* `ObjPresenceCheckInProgress` - Indicates that the checking for object presence is in progress.\n* `ObjPresenceCheckInComplete` - Indicates that the request is being processed.\n* `ObjPresenceCheckFailed` - Indicates that the checking for object presence failed.\n* `Processing` - Indicates that the request is being processed.\n* `TimedOut` - Indicates that the request processing timed out.\n* `Failed` - Indicates that the request processing failed.\n* `Completed` - Indicates that the request processing is complete.\n* `Partial` - Indicates that the request is partially complete due to an error.\n* `Skipped` - Indicates that the request was skipped.", "type": "string", "enum": [ "Pending", "ObjPresenceCheckInProgress", "ObjPresenceCheckInComplete", "ObjPresenceCheckFailed", "Processing", "TimedOut", "Failed", "Completed", "Partial", "Skipped" ], "default": "Pending", "readOnly": true, "x-omitempty": true }, "SystemDefinedObjectDetected": { "description": "This flag indicates if the a system defined object was detected after execution of the action CheckObjectPresence.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "TargetMoid": { "description": "Used with PATCH & DELETE actions. The moid of an existing object instance.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Uri": { "description": "The URI on which this bulk action is to be performed.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Verb": { "description": "The type of operation to be performed.\nOne of - Post (Create), Patch (Update) or Delete (Remove).\n* `POST` - Used to create a REST resource.\n* `PATCH` - Used to update a REST resource.\n* `DELETE` - Used to delete a REST resource.", "type": "string", "enum": [ "POST", "PATCH", "DELETE" ], "default": "POST", "x-createOnly": true, "x-omitempty": true }, "AsyncRequest": { "$ref": "#/components/schemas/bulk.Result.Relationship", "description": "A reference to a bulkResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Request": { "$ref": "#/components/schemas/bulk.Request.Relationship", "description": "A reference to a bulkRequest resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "bulk.SubRequestObj.List": { "title": "List of 'bulk.SubRequestObj' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bulk.SubRequestObj' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bulk.SubRequestObj' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.SubRequestObj" }, "nullable": true } } } ] }, "bulk.SubRequestsGroup": { "title": "Bulk:Sub Requests Group", "description": "A group of bulk sub requests that can be sent in a single bulk API request. In case of an export operation\nwith many MOs, the exported MOs are grouped as many sub requests group and returned.", "x-allOf-name": "bulk.SubRequestsGroup", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'bulk.SubRequestsGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bulk.SubRequestsGroup" ], "default": "bulk.SubRequestsGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bulk.SubRequestsGroup" ], "default": "bulk.SubRequestsGroup", "x-enum-as-string": true }, "Requests": { "type": "array", "items": { "description": "A group of bulk sub requests that can be sent in a single bulk API request.", "$ref": "#/components/schemas/bulk.SubRequest", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "cli.CliPolicy.Response": { "description": "The response body of a HTTP GET request for the 'cli.CliPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cli.CliPolicy' resources.", "x-one-of-name": "cli.CliPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cli.CliPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cli.CliPolicy": { "title": "Cli:Cli Policy", "description": "The CliPolicy object manages policies controlling FI and Unified Edge eCMC CLI launches within the account. This provides configuration options for enabling or disabling FI and Unified Edge eCMC CLI launches within the account.\n#### Purpose\nCliPolicy enables organizations to manage and control FI and Unified Edge eCMC CLI launches through policy configuration. It ensures secure and efficient access by allowing account-specific configurations.\n#### Key Concepts\n- **Policy Management:** Manages policies for FI and Unified Edge eCMC CLI launches, ensuring secure and efficient access operations.\n- **Configuration Options:** Provides options to enable or disable FI and Unified Edge eCMC CLI launches within the account, supporting tailored access control.", "x-allOf-name": "cli.CliPolicy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cli.CliPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cli.CliPolicy" ], "default": "cli.CliPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cli.CliPolicy" ], "default": "cli.CliPolicy", "x-enum-as-string": true }, "FiAndUnifiedEdgeEcmcCliLaunch": { "description": "Enable or Disable launching FI and Unified Edge eCMC CLI within the account.", "type": "boolean", "default": false, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "cli.CliPolicy.List": { "title": "List of 'cli.CliPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cli.CliPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cli.CliPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cli.CliPolicy" }, "nullable": true } } } ] }, "cloud.CollectInventory": { "title": "Cloud:Collect Inventory", "description": "The CollectInventory object plays a crucial role in managing and collecting inventory data asynchronously after the creation of new Terraform Cloud targets. It interfaces with inventory collectors to gather information about organizations, agent pools, and workspaces on Terraform Cloud.\n#### Purpose\nCollectInventory is designed to streamline inventory management by automating data collection processes. It ensures accurate tracking of cloud assets and their associated organizational structures.\n#### Key Concepts\n- **Asynchronous Operations:** Supports non-blocking inventory collection processes.\n- **Data Aggregation:** Collects and consolidates data pertaining to organizations and resources.\n- **Integration with Terraform Cloud:** Seamlessly interfaces with Terraform Cloud assets.\n- **Access Control:** Employs privilege sets for managing permissions and ensuring secure data handling.", "x-allOf-name": "cloud.CollectInventory", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cloud.CollectInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cloud.CollectInventory" ], "default": "cloud.CollectInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cloud.CollectInventory" ], "default": "cloud.CollectInventory", "x-enum-as-string": true }, "TargetId": { "description": "The id of the new Terraform cloud asset which was created.", "type": "string", "x-omitempty": true }, "Target": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "cloud.TfcAgentpool.Response": { "description": "The response body of a HTTP GET request for the 'cloud.TfcAgentpool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cloud.TfcAgentpool' resources.", "x-one-of-name": "cloud.TfcAgentpool.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cloud.TfcAgentpool.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cloud.TfcAgentpool": { "title": "Cloud:Tfc Agentpool", "description": "The TfcAgentpool object is integral to managing groups of agents within Terraform Cloud, enabling communication with isolated, private, or on-premises infrastructure. \n#### Purpose\nIntersight discovers the Agent Pools in the Terraform Cloud account whose credentials are specified in the Terraform Cloud target.\n#### Key Concepts\n- **Agent Grouping:** Represents a collection of Terraform Cloud agents used to execute runs against private, isolated, or on-premises environments.\n- **Credential-Based Discovery:** Intersight identifies available agent pools using the credentials specified in the Terraform Cloud target.", "x-allOf-name": "cloud.TfcAgentpool", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cloud.TfcAgentpool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cloud.TfcAgentpool" ], "default": "cloud.TfcAgentpool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cloud.TfcAgentpool" ], "default": "cloud.TfcAgentpool", "x-enum-as-string": true }, "Identity": { "description": "The ID of the Agent Pool.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the agent pool.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumActiveAgents": { "description": "The number of active agents used by this pool. The total active agent are sum of idle, busy and unknown agent counts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumTokens": { "description": "The number of Tokens in this agent Pool.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/components/schemas/cloud.TfcOrganization.Relationship", "description": "A reference to a cloudTfcOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "cloud.TfcAgentpool.List": { "title": "List of 'cloud.TfcAgentpool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cloud.TfcAgentpool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cloud.TfcAgentpool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cloud.TfcAgentpool" }, "nullable": true } } } ] }, "cloud.TfcOrganization.Response": { "description": "The response body of a HTTP GET request for the 'cloud.TfcOrganization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cloud.TfcOrganization' resources.", "x-one-of-name": "cloud.TfcOrganization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cloud.TfcOrganization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cloud.TfcOrganization.Relationship": { "description": "A relationship to the 'cloud.TfcOrganization' resource, or the expanded 'cloud.TfcOrganization' resource, or the 'null' value.", "x-one-of-name": "cloud.TfcOrganization.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/cloud.TfcOrganization" } ], "discriminator": { "propertyName": "ClassId" } }, "cloud.TfcOrganization": { "title": "Cloud:Tfc Organization", "description": "The TfcOrganization object represents a collaborative space within Terraform Cloud, enabling teams to work together on shared workspaces. Intersight discovers the Organizations in the Terraform Cloud account whose credentials are specified in the Terraform Cloud target.\n#### Purpose\nDefines a collaborative space in Terraform Cloud where teams manage shared workspaces and enables Intersight to discover Terraform Cloud organizations using the credentials specified in the Terraform Cloud target.\n#### Key Concepts\n- **Collaborative Workspace Boundary:** Represents a logical grouping in Terraform Cloud where users, teams, and workspaces are organized for shared IaC operations.\n- **Credential-Based Discovery:** Intersight automatically identifies all Terraform Cloud organizations accessible through the credentials defined in a Terraform Cloud target.\nOrganizations are a shared space for teams to collaborate on workspaces in Terraform Cloud.", "x-allOf-name": "cloud.TfcOrganization", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cloud.TfcOrganization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cloud.TfcOrganization" ], "default": "cloud.TfcOrganization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cloud.TfcOrganization" ], "default": "cloud.TfcOrganization", "x-enum-as-string": true }, "AgentCeiling": { "description": "The max number of active agents allowed in this organization.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Email": { "description": "The admin email address associated with a user under this organization.", "type": "string", "readOnly": true, "x-omitempty": true }, "Identity": { "description": "The ID of the organization.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the organization.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumTeams": { "description": "The number of teams under this organization.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumUsers": { "description": "The number of users in this organization.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RunCeiling": { "description": "The max number of simultaneous runs allowed in this organization.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VcsProviders": { "description": "Total number of VCS providers in the organization.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Target": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "cloud.TfcOrganization.List": { "title": "List of 'cloud.TfcOrganization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cloud.TfcOrganization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cloud.TfcOrganization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cloud.TfcOrganization" }, "nullable": true } } } ] }, "cloud.TfcWorkspace.Response": { "description": "The response body of a HTTP GET request for the 'cloud.TfcWorkspace' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cloud.TfcWorkspace' resources.", "x-one-of-name": "cloud.TfcWorkspace.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cloud.TfcWorkspace.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cloud.TfcWorkspace": { "title": "Cloud:Tfc Workspace", "description": "The TfcWorkspace object serves as a representation of running infrastructure managed by Terraform. \n#### Purpose\nIntersight discovers the Workspaces in the Terraform Cloud account whose credentials are specified in the Terraform Cloud target.\n#### Key Concepts\n- **Infrastructure Representation:** Represents an active Terraform-managed environment, encapsulating configuration, state, and execution history.\n- **Credential-Based Discovery:** Intersight automatically discovers Terraform Cloud workspaces using the credentials defined in the Terraform Cloud target.", "x-allOf-name": "cloud.TfcWorkspace", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cloud.TfcWorkspace', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cloud.TfcWorkspace" ], "default": "cloud.TfcWorkspace", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cloud.TfcWorkspace" ], "default": "cloud.TfcWorkspace", "x-enum-as-string": true }, "AgentPoolId": { "description": "The agent pool associated with this workspace.", "type": "string", "readOnly": true, "x-omitempty": true }, "ApplyMethod": { "description": "Whether or not Terraform Cloud should automatically apply a successful Terraform plan.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ExecutionMode": { "description": "Indicates where the Terraform cloud should execute the runs.", "type": "string", "readOnly": true, "x-omitempty": true }, "Identity": { "description": "The unique id for this workspace.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastRunStatus": { "description": "The status of the last executed run in this workspace.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the workspace.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkspaceVariables": { "type": "array", "items": { "description": "Workspace variables and its related attributes.", "$ref": "#/components/schemas/cloud.TfcWorkspaceVariables", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "#/components/schemas/cloud.TfcOrganization.Relationship", "description": "A reference to a cloudTfcOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "cloud.TfcWorkspace.List": { "title": "List of 'cloud.TfcWorkspace' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cloud.TfcWorkspace' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cloud.TfcWorkspace' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cloud.TfcWorkspace" }, "nullable": true } } } ] }, "cloud.TfcWorkspaceVariables": { "title": "Cloud:Tfc Workspace Variables", "description": "The variables associated with a workspace.", "x-allOf-name": "cloud.TfcWorkspaceVariables", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cloud.TfcWorkspaceVariables', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cloud.TfcWorkspaceVariables" ], "default": "cloud.TfcWorkspaceVariables", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cloud.TfcWorkspaceVariables" ], "default": "cloud.TfcWorkspaceVariables", "x-enum-as-string": true }, "Category": { "description": "Whether this is a Terraform environment variable. Valid values are \"terraform\" or \"env\".", "type": "string", "x-omitempty": true }, "Description": { "description": "The description of the variable.", "type": "string", "x-omitempty": true }, "Hcl": { "description": "Whether to evaluate the value of the variable as a string of HCL code. Has no effect for environment variables.", "type": "boolean", "x-omitempty": true }, "Identity": { "description": "The unique identifier for this variable.", "type": "string", "x-omitempty": true }, "Key": { "description": "The name of the variables.", "type": "string", "x-omitempty": true }, "Sensitive": { "description": "Whether the value is sensitive. If true then variable is written once and not visible thereafter.", "type": "boolean", "x-omitempty": true }, "Value": { "description": "The value of the variables.", "type": "string", "x-omitempty": true } } } ] }, "cmrf.CmRf": { "title": "Cmrf:Cm Rf", "description": "A reference to a REST resource from a complex type, uniquely identified by object type and Moid.\nCMRF is a short term workaround until MoRef properties of complex types can be supported.\nCMRF means complex type managed object reference and is unique enough that it can be removed easily later.\nThe long term solution is to support for relationships stanza under complextypes.\nDeprecated.", "x-allOf-name": "cmrf.CmRf", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cmrf.CmRf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType", "objectType" ], "properties": { "Moid": { "description": "The Moid of the referenced REST resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Selector": { "description": "An OData $filter expression which describes the REST resource to be referenced. This field may\nbe set instead of 'moid' by clients.\n1. If 'moid' is set this field is ignored.\n1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the\nresource matching the filter expression and populates it in the Cmrf that is part of the object\ninstance being inserted/updated to fulfill the REST request.\nAn error is returned if the filter matches zero or more than one REST resource.\nAn example filter string is: Serial eq '3AA8B7T11'.", "type": "string", "x-omitempty": true } } } ] }, "cond.AdapterBaselineStatus": { "title": "Cond:Adapter Baseline Status", "description": "Adapter baseline status specifies the adapter status and reason of being non-compliant when status is non-compliant.", "x-allOf-name": "cond.AdapterBaselineStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AdapterBaselineStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AdapterBaselineStatus" ], "default": "cond.AdapterBaselineStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AdapterBaselineStatus" ], "default": "cond.AdapterBaselineStatus", "x-enum-as-string": true }, "Adapter": { "description": "The adapter MoRef for the baseline status.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "The baseline status reason of the adapter.\n* `NotApplicable` - Reason is not applicable for the specified baseline status.\n* `Compliant` - Custom Hcl Baseline properties are matched with server's properties.\n* `ServerModelNotMatched` - Server model of the server does not matched with custom Hcl baseline's server model.\n* `ProcessorNotMatched` - Processor of the server does not matched with custom Hcl baseline's processor.\n* `FirmwareVersionNotMatched` - Firmware version of the server does not matched with custom Hcl baseline's firmware version.\n* `ManagementModeNotMatched` - ManagementMode of the server does not matched with custom Hcl baseline's management mode.\n* `GenerationNotMatched` - Generation of the server does not matched with custom Hcl baseline's generation.\n* `PersonalityNotMatched` - Personality of the server does not matched with custom Hcl baseline's personality.\n* `OsVendorNotMatched` - Operating system vendor of the server does not matched with custom Hcl baseline's operating system vendor.\n* `OsVersionNotMatched` - Operating system version of the server does not matched with custom Hcl baseline's operating system version.\n* `AdapterModelNotMatched` - Adapter model of the server does not matched with custom Hcl baseline's adapter model.\n* `AdapterFirmwareNotMatched` - Adapter firmware version of the server does not matched with custom Hcl baseline's adapter adapter firmware version.\n* `AdapterTypeNotMatched` - Adapter Type of the server does not matched with custom Hcl baseline's adapter type.\n* `AdapterDriverProtocolNotMatched` - Adapter driver name of the server does not matched with custom Hcl baseline's adapter driver name.\n* `AdapterDriverVersionNotMatched` - Adapter driver version of the server does not matched with custom Hcl baseline's adapter driver version.\n* `AdapterNotMatched` - One or morecustom Hcl adapter of the server does not matched with custom Hcl baseline's adapter details.\n* `AdapterVendorNotMatched` - Adapter vendor of the server does not matched with custom Hcl baseline's adapter vendor.", "type": "string", "enum": [ "NotApplicable", "Compliant", "ServerModelNotMatched", "ProcessorNotMatched", "FirmwareVersionNotMatched", "ManagementModeNotMatched", "GenerationNotMatched", "PersonalityNotMatched", "OsVendorNotMatched", "OsVersionNotMatched", "AdapterModelNotMatched", "AdapterFirmwareNotMatched", "AdapterTypeNotMatched", "AdapterDriverProtocolNotMatched", "AdapterDriverVersionNotMatched", "AdapterNotMatched", "AdapterVendorNotMatched" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The baseline status of the adapter.\n* `NotApplicable` - Indicates that the custom Hcl baseline is not applicable to the server.\n* `Compliant` - Indicates that the server baseline status is validated and compliant with the defined custom Hcl baseline.\n* `NonCompliant` - Indicates that the server baseline status is not validated or does not meet the defined custom Hcl baseline.", "type": "string", "enum": [ "NotApplicable", "Compliant", "NonCompliant" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true } } } ] }, "cond.AdapterDetail": { "title": "Cond:Adapter Detail", "description": "Adapter details for custom Hcl baseline.", "x-allOf-name": "cond.AdapterDetail", "allOf": [ { "$ref": "#/components/schemas/cond.AdapterInfo" } ] }, "cond.AdapterInfo": { "title": "Cond:Adapter Info", "description": "Adapter information like model, vendor, type, firmware and driver details.", "x-allOf-name": "cond.AdapterInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AdapterInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "cond.AdapterDetail", "cond.AdapterInstance" ], "x-enum-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": [ "cond.AdapterDetail", "cond.AdapterInstance" ], "x-enum-as-string": true }, "DriverName": { "description": "It specifies the name of the driver supported by the adapter.", "type": "string", "minLength": 1, "maxLength": 255, "x-omitempty": true }, "DriverVersion": { "description": "It specifies the version of the driver installed for the adapter.", "type": "string", "minLength": 1, "maxLength": 255, "x-omitempty": true }, "Firmware": { "description": "It specifies the firmware version installed on the adapter.", "type": "string", "x-omitempty": true }, "HclReason": { "description": "The reason for the Cisco HCL validation status, more useful when status is NotListed.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor and version was not found in HCL for the server PID and processor combination.\n* `Incompatible-Component-Model` - The validation failed because the given Component model was not found in the HCL for the given server PID, processor, server Firmware and operating system vendor and version.\n* `Incompatible-Firmware` - The validation failed because the given server firmware or adapter firmware was not found in the HCL for the given server PID, processor, operating system vendor and version and component model.\n* `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version, server firmware and component firmware.\n* `Incompatible-Firmware-Driver` - The validation failed because the given component firmware and driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version and server firmware.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result.\n* `Unrecognized-Protocol` - The validation has failed for the HCL component because the HCL data service has return a validation reason that is unknown to this service. This reason is used as a default failure reason reason in case we cannot map the error reason received from the HCL data service unto one of the other enum values.\n* `Not-Evaluated` - The validation for the hardware or software HCL status was not yet evaluated because some previous validation had failed. For example if a server's hardware profile fails to validate with HCL, then the server's software status will not be evaluated.\n* `Compatible` - The validation has passed for this server PID, processor, operating system vendor and version, component model, component firmware and driver version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server-With-Component", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Component-Model", "Incompatible-Firmware", "Incompatible-Driver", "Incompatible-Firmware-Driver", "Service-Unavailable", "Service-Error", "Unrecognized-Protocol", "Not-Evaluated", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "HclStatus": { "description": "The Cisco HCL validation status of the adapter.\n* `Incomplete` - This means we do not have operating system information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that in component's hardware or software profile was not found in the HCL.\n* `Not-Listed` - At the HclStatus level, this means that some part of the HCL validation has failed. This could be that either the server's hardware or software profile was not listed in the HCL or one of the components' hardware or software profile was not found in the HCL.\n* `Validated` - At the HclStatus level, this means that all of the components have passed validation. At HclStatusDetail level, this means that the component's hardware or software profile was found in the HCL.\n* `Not-Evaluated` - At the HclStatus level this means that this means that SW or Component status has not been evaluated as the previous evaluation step has not passed yet or the configurations provided are insufficient for HCL status assessment. At the HclStatusDetail level this means that either HW or SW status has not been evaluted because a previous evaluation step has not passed yet.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.", "type": "string", "enum": [ "Incomplete", "Not-Found", "Not-Listed", "Validated", "Not-Evaluated", "Not-Applicable" ], "default": "Incomplete", "readOnly": true, "x-omitempty": true }, "Model": { "description": "It specifies the model name or Product ID (PID) of the adapter.", "type": "string", "minLength": 1, "maxLength": 255, "x-omitempty": true }, "Type": { "description": "It specifies the type of the adapter, such as Network Adapter, Storage Controller, or GPU.\n* `Unknown` - It indicates no adapter type. it is used when component type enum is not defined.\n* `NetworkAdapter` - Indicates network adapter.\n* `StorageController` - Indicates Storage controller.\n* `GPU` - It refers to Graphics Processing Unit (GPU) adapters, which are used for rendering graphics and performing parallel processing tasks.\n* `SSD` - It refers NVME solid state drives (SSD) drives.", "type": "string", "enum": [ "Unknown", "NetworkAdapter", "StorageController", "GPU", "SSD" ], "default": "Unknown", "x-omitempty": true }, "Vendor": { "description": "It specifies the vendor or manufacturer of the adapter.", "type": "string", "minLength": 1, "maxLength": 100, "x-omitempty": true } } } ] }, "cond.AdapterInstance": { "title": "Cond:Adapter Instance", "description": "Adapter details retrieved from server.", "x-allOf-name": "cond.AdapterInstance", "allOf": [ { "$ref": "#/components/schemas/cond.AdapterInfo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AdapterInstance', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AdapterInstance" ], "default": "cond.AdapterInstance", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AdapterInstance" ], "default": "cond.AdapterInstance", "x-enum-as-string": true }, "Adapter": { "description": "The adapter relationship object to identify adapter in inventory.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true } } } ] }, "cond.Alarm.Response": { "description": "The response body of a HTTP GET request for the 'cond.Alarm' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.Alarm' resources.", "x-one-of-name": "cond.Alarm.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.Alarm.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.Alarm": { "title": "Cond:Alarm", "description": "The Alarm object represents the alarms generated by either the managed system itself or by Intersight. It is used for identifying and responding to issues detected across various managed objects.\n#### Purpose\nThe Alarm object is crucial for tracking the state and severity of issues, providing a structured approach to alarm management. It ensures that alarms are reported consistently and can be acknowledged or suppressed based on user needs.\n#### Key Concepts\n- **Severity:** Alarms are categorized by severity levels (Critical, Warning, Info, and Cleared), offering a standardized way to prioritize and respond to detected issues.\n- **Acknowledgement and Suppression:** Users can acknowledge alarms to exclude them from health status and overall counts, while suppression settings control visibility.\n- **Integrated Relationships:** Alarms are linked to definitions and affected managed objects, ensuring comprehensive tracking and management of issues.", "x-allOf-name": "cond.Alarm", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.Alarm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.Alarm" ], "default": "cond.Alarm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.Alarm" ], "default": "cond.Alarm", "x-enum-as-string": true }, "Acknowledge": { "description": "Alarm acknowledgment state. Default value is None.\n* `None` - The Enum value None represents that the alarm is not acknowledged and is included as part of health status and overall alarm count.\n* `Acknowledge` - The Enum value Acknowledge represents that the alarm is acknowledged by user. The alarm will be ignored from the health status and overall alarm count.", "type": "string", "enum": [ "None", "Acknowledge" ], "default": "None", "x-omitempty": true }, "AcknowledgeBy": { "description": "User who acknowledged the alarm.", "type": "string", "readOnly": true, "x-omitempty": true }, "AcknowledgeTime": { "description": "Time at which the alarm was acknowledged by the user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "AffectedMoDisplayName": { "description": "Display name of the affected object on which the alarm is raised. The name uniquely identifies an alarm target such that it can be distinguished from similar objects managed by Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "AffectedMoId": { "description": "MoId of the affected object from the managed system's point of view.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "readOnly": true, "x-omitempty": true }, "AffectedMoType": { "description": "Managed system affected object type. For example Adaptor, FI, CIMC.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "readOnly": true, "x-omitempty": true }, "AffectedObject": { "description": "A unique key for an alarm instance, consists of a combination of a unique system name and msAffectedObject.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "readOnly": true, "x-omitempty": true }, "AncestorMoId": { "description": "Parent MoId of the fault from managed system. For example, Blade moid for adaptor fault.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "readOnly": true, "x-omitempty": true }, "AncestorMoType": { "description": "Parent MO type of the fault from managed system. For example, Blade for adaptor fault.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "readOnly": true, "x-omitempty": true }, "Code": { "description": "A unique alarm code. For alarms mapped from UCS faults, this will be the same as the UCS fault code.", "type": "string", "readOnly": true, "x-omitempty": true }, "CreationTime": { "description": "The time the alarm was created.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Description": { "description": "A longer description of the alarm than the name. The description contains details of the component reporting the issue.", "type": "string", "readOnly": true, "x-omitempty": true }, "Flapping": { "description": "Alarm flapping state. This will be set to Flapping or Cooldown if both (A) this type of alarm is being monitored for flapping conditions, and (B) the alarm has recently transitioned to an active state (Critical, Warning or Info) followed by a Cleared state or vice versa. LastTransitionTime is a better field to use to know whether a particular alarm recently changed state.\n* `NotFlapping` - The enum value None says that no recent flaps have occurred.\n* `Flapping` - The enum value Flapping says that the alarm has become active recently, after being active and then cleared previously.\n* `Cooldown` - The enum value Cooldown says that the alarm is cleared, but was recently active.\n* `Unknown` - The enum value Unknown indicates that you might not have the latest version of the property meta.", "type": "string", "enum": [ "NotFlapping", "Flapping", "Cooldown", "Unknown" ], "default": "NotFlapping", "readOnly": true, "x-omitempty": true }, "FlappingCount": { "description": "Alarm flapping counter. This will be incremented every time the state of the alarm transitions to an active state (Critical, Warning or Info) followed by a Cleared state or vice versa. If no more transitions occur within the system-defined flap interval (usually less than 5 minutes), the counter will be reset to zero. This represents the amount of times the alarm has flapped between an active and a cleared state since the last time the Flapping state was cleared.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FlappingStartTime": { "description": "Alarm flapping start time. Only when the flapping state is Flapping or Cooldown, this will be set to the time the alarm began flapping. If the flapping state is NotFlapping, this timestamp may be set to zero or any other time and should be ignored.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastTransitionTime": { "description": "The time the alarm last had a change in severity.", "type": "string", "format": "date-time", "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 }, "MsAffectedObject": { "description": "A unique key for the alarm from the managed system's point of view. For example, in the case of UCS, this is the fault's dn.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Uniquely identifies the type of alarm. For alarms originating from Intersight, this will be a descriptive name. For alarms that are mapped from faults, the name will be derived from fault properties. For example, alarms mapped from UCS faults will use a prefix of UCS and appended with the fault code.", "type": "string", "readOnly": true, "x-omitempty": true }, "OrigSeverity": { "description": "The original severity when the alarm was first created.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "The severity of the alarm. Valid values are Critical, Warning, Info, and Cleared.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Suppressed": { "description": "Indicates whether the alarm is marked for suppression or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SuppressedTime": { "description": "Time at which the last alarm suppression state change happened.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "AffectedMo": { "$ref": "#/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." }, "AlarmSummaryAggregators": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "Definition": { "$ref": "#/components/schemas/cond.AlarmDefinition.Relationship", "description": "A reference to a condAlarmDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "RegisteredDevice": { "$ref": "#/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." }, "SuppressionRules": { "description": "An array of relationships to condAlarmSuppression resources.", "type": "array", "items": { "$ref": "#/components/schemas/cond.AlarmSuppression.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "cond.Alarm.List": { "title": "List of 'cond.Alarm' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.Alarm' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.Alarm' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.Alarm" }, "nullable": true } } } ] }, "cond.AlarmAction": { "title": "Cond:Alarm Action", "description": "AlarmAction is used to define actions that are triggered in response to alarms.\n#### Purpose\nAlarmAction defines the specific rules and specifications used to construct alarm instances in response to system events. It includes detailed messaging and severity specification to support issue resolution and system monitoring.\n#### Key Concepts\n- **Action Triggering:** AlarmAction defines actions that are automatically triggered in response to alarms, such as email notifications or webhook calls, enabling automated responses based on alarm severity and acknowledgment status.\n- **Rule Configuration:** It specifies rules and parameters to construct alarm instances tied to system events, including detailed messaging and severity levels to aid in issue resolution and system monitoring.\n- **Notification Automation:** Users can configure AlarmAction to automatically notify themselves or external systems when specific alarm conditions occur, facilitating timely and appropriate responses to infrastructure events.\n- **Severity and Messaging:** AlarmAction allows customization of alarm severity and messages, helping prioritize and address system events effectively.", "x-allOf-name": "cond.AlarmAction", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmAction', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmAction" ], "default": "cond.AlarmAction", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmAction" ], "default": "cond.AlarmAction", "x-enum-as-string": true }, "Message": { "description": "A description of the detected issue which often includes instance specific details.", "$ref": "#/components/schemas/issue.Message", "x-omitempty": true }, "Spec": { "description": "A specification of the details used to construct an alarm instance.", "$ref": "#/components/schemas/cond.AlarmSpec", "x-omitempty": true } } } ] }, "cond.AlarmAggregation.Response": { "description": "The response body of a HTTP GET request for the 'cond.AlarmAggregation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.AlarmAggregation' resources.", "x-one-of-name": "cond.AlarmAggregation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.AlarmAggregation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.AlarmAggregation": { "title": "Cond:Alarm Aggregation", "description": "The AlarmAggregation object is designed to represent aggregated alarm data for a managed endpoint within Intersight. It offers a consolidated view of alarm counts and severity levels, supporting efficient monitoring and management of endpoint health.\n#### Purpose\nAlarmAggregation provides a summary of alarm data, aiding users in understanding the overall health and alarm status of managed endpoints. It is essential for assessing the impact of alarms on system performance and decision-making.\n#### Key Concepts\n- **Summary of Severity:** Aggregates alarm counts based on severity types (Critical, Warning, Info), giving users a clear view of alarm distribution.\n- **Endpoint Health Assessment:** Evaluates and reports the health status of endpoints based on aggregated alarm data, supporting proactive management.\n- **Relationship-Driven:** Tied to alarm aggregation sources within the managed object hierarchy, ensuring accurate and relevant aggregation data.\n- **Read-Only Access:** Designed for safe consumption, allowing users to integrate and assess alarm data without modifying it directly.", "x-allOf-name": "cond.AlarmAggregation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmAggregation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmAggregation" ], "default": "cond.AlarmAggregation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmAggregation" ], "default": "cond.AlarmAggregation", "x-enum-as-string": true }, "AlarmSummary": { "description": "The summary of alarm counts based on the severity types (Critical or Warning).", "$ref": "#/components/schemas/cond.AlarmSummary", "readOnly": true, "x-omitempty": true }, "CriticalAlarmsCount": { "description": "Count of all alarms with severity Critical, irrespective of acknowledgement status.", "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* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "readOnly": true, "x-omitempty": true }, "InfoAlarmsCount": { "description": "Count of all alarms with severity Info, irrespective of acknowledgement status.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MoType": { "description": "Managed object type. For example, FI managed object type will be network.Element.", "type": "string", "readOnly": true, "x-omitempty": true }, "WarningAlarmsCount": { "description": "Count of all alarms with severity Warning, irrespective of acknowledgement status.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AlarmAggregationSource": { "$ref": "#/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 } } } ] }, "cond.AlarmAggregation.List": { "title": "List of 'cond.AlarmAggregation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.AlarmAggregation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.AlarmAggregation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.AlarmAggregation" }, "nullable": true } } } ] }, "cond.AlarmClassification.Response": { "description": "The response body of a HTTP GET request for the 'cond.AlarmClassification' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.AlarmClassification' resources.", "x-one-of-name": "cond.AlarmClassification.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.AlarmClassification.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.AlarmClassification.Relationship": { "description": "A relationship to the 'cond.AlarmClassification' resource, or the expanded 'cond.AlarmClassification' resource, or the 'null' value.", "x-one-of-name": "cond.AlarmClassification.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/cond.AlarmClassification" } ], "discriminator": { "propertyName": "ClassId" } }, "cond.AlarmClassification": { "title": "Alarm Classification", "description": "A group of related alarms that can be used in suppressions.", "x-allOf-name": "cond.AlarmClassification", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmClassification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmClassification" ], "default": "cond.AlarmClassification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmClassification" ], "default": "cond.AlarmClassification", "x-enum-as-string": true }, "AppliesTo": { "type": "array", "items": { "description": "An alarm classification can be used in multiple suppressions on different entity MO types.\nThis property captures the list of MO types where this classification can be suppressed.", "$ref": "#/components/schemas/cond.AlarmClassificationEligibility", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Description": { "description": "A description about the alarms group that usually gives what kind of alarms are part of this classification.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name that uniquely identifies the alarm classificaton.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "readOnly": true, "x-omitempty": true }, "AlarmDefinitions": { "description": "An array of relationships to condAlarmDefinition resources.", "type": "array", "items": { "$ref": "#/components/schemas/cond.AlarmDefinition.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "cond.AlarmClassification.List": { "title": "List of 'cond.AlarmClassification' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.AlarmClassification' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.AlarmClassification' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.AlarmClassification" }, "nullable": true } } } ] }, "cond.AlarmClassificationEligibility": { "title": "Cond:Alarm Classification Eligibility", "description": "Same alarm classifications can be suppressed at many Intersight entity MO types. The entity MO types on which an alarm classification can be suppressed is determined by the alarm classification eligibility captured in alarm classifications.", "x-allOf-name": "cond.AlarmClassificationEligibility", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmClassificationEligibility', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmClassificationEligibility" ], "default": "cond.AlarmClassificationEligibility", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmClassificationEligibility" ], "default": "cond.AlarmClassificationEligibility", "x-enum-as-string": true }, "EntityType": { "description": "The Intersight MO type on which a classification can be suppressed.", "type": "string", "x-omitempty": true } } } ] }, "cond.AlarmDefinition.Response": { "description": "The response body of a HTTP GET request for the 'cond.AlarmDefinition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.AlarmDefinition' resources.", "x-one-of-name": "cond.AlarmDefinition.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.AlarmDefinition.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.AlarmDefinition.Relationship": { "description": "A relationship to the 'cond.AlarmDefinition' resource, or the expanded 'cond.AlarmDefinition' resource, or the 'null' value.", "x-one-of-name": "cond.AlarmDefinition.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/cond.AlarmDefinition" } ], "discriminator": { "propertyName": "ClassId" } }, "cond.AlarmDefinition": { "title": "Cond:Alarm Definition", "description": "AlarmDefinition describes alarm messages, including their meaning and recommended recovery actions. It helps identify alarms by providing details such as the alarm name, description, severity, and suggested troubleshooting steps, aiding administrators in managing and responding to system alarms effectively.\n#### Purpose\nAn AlarmDefinition specifies the conditions under which an alarm is generated and the corresponding actions to be performed. It acts as a blueprint for alarm creation by combining detection logic, descriptive information, and the defined response actions.\n#### Key Concepts\n- **Alarm Actions:** Specifies the set of alarms to be raised, including detailed messaging and severity levels, providing a consistent and automated response to detected issues.\n- **Read-Only Access:** Designed exclusively primarily for consumption, supporting safe and consistent integration with external systems and user interfaces.", "x-allOf-name": "cond.AlarmDefinition", "allOf": [ { "$ref": "#/components/schemas/issue.Definition" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmDefinition" ], "default": "cond.AlarmDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmDefinition" ], "default": "cond.AlarmDefinition", "x-enum-as-string": true }, "Actions": { "type": "array", "items": { "description": "The alarms to be raised when an issue is detected.", "$ref": "#/components/schemas/cond.AlarmAction", "x-omitempty": true }, "nullable": true }, "Status": { "description": "Controls the behavior of alarm processing depending upon the status. If Enabled, alarm is evaluated for any condition that meets the criteria. If Disabled or SystemDisabled, alarm is not evaluated and the existing alarms for this AlarmDefinition is cleared. If Inactive, alarm is not evaluated and the existing alarms for this AlarmDefinition is deleted.\n* `Enabled` - Enables alarm evaluation for any condition that meets the criteria.\n* `Disabled` - Disables alarm evaluation temporarily and clears the existing alarms.\n* `SystemDisabled` - Disables alarm evaluation temporarily and clears the existing alarms once alarm limit per alarm rule is reached.\n* `Inactive` - Stops alarm evaluation permanently and deletes the existing alarms.", "type": "string", "enum": [ "Enabled", "Disabled", "SystemDisabled", "Inactive" ], "default": "Enabled", "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Device": { "$ref": "#/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 }, "ThresholdDefinition": { "$ref": "#/components/schemas/cond.ThresholdDefinition.Relationship", "description": "A reference to a condThresholdDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "cond.AlarmDefinition.List": { "title": "List of 'cond.AlarmDefinition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.AlarmDefinition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.AlarmDefinition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.AlarmDefinition" }, "nullable": true } } } ] }, "cond.AlarmPreview": { "title": "Cond:Alarm Preview", "description": "Contains a list of alarms with a fixed subset of fields needed to show a preview.", "x-allOf-name": "cond.AlarmPreview", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmPreview', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmPreview" ], "default": "cond.AlarmPreview", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmPreview" ], "default": "cond.AlarmPreview", "x-enum-as-string": true }, "AffectedMo": { "description": "The AffectedMo field of the alarm. Contains the field ObjectType, known in the UI as\nAffected Type.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "AffectedName": { "description": "The AffectedMoDisplayName field of the alarm, known in the UI as Affected Name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Code": { "description": "The alarm code. For alarms mapped from UCS faults, this will be the same as the UCS\nfault code.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "The description of the alarm.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastTransitionTime": { "description": "The LastTransitionTime field of the alarm.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "The severity of the alarm.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "readOnly": true, "x-omitempty": true } } } ] }, "cond.AlarmRule.Response": { "description": "The response body of a HTTP GET request for the 'cond.AlarmRule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.AlarmRule' resources.", "x-one-of-name": "cond.AlarmRule.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.AlarmRule.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.AlarmRule": { "title": "Cond:Alarm Rule", "description": "A container object that aggregates a set of ThresholdDefinition objects. This can be assigned to one or more devices, triggering the creation of the AlarmDefinition which enables centralized management and consistent application of ThresholdDefinition objects across multiple resources.", "x-allOf-name": "cond.AlarmRule", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmRule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmRule" ], "default": "cond.AlarmRule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmRule" ], "default": "cond.AlarmRule", "x-enum-as-string": true }, "Description": { "description": "Informative description of AlarmRule.", "type": "string", "x-omitempty": true }, "Name": { "description": "A unique name assigned by the user to AlarmRule. This user-defined name acts as the identity field, ensuring that AlarmRule is distinctly identifiable within the account.", "type": "string", "x-omitempty": true }, "State": { "description": "Controls the behavior of alarm processing depending upon the state. If Enabled, which is also the default behavior, the alarm is evaluated for the device based on the conditions specified in the ThresholdDefinition objects attached to it. If Disabled or SystemDisabled, alarm is not evaluated for the device and the existing alarms raised against the device is cleared.\n* `Enabled` - User initiated action which is also the default action that enables alarm evaluation for any condition that meets the criteria.\n* `Disabled` - User initiated action that disables alarm evaluation temporarily and clears the existing alarms.\n* `SystemDisabled` - System initiated action that disables alarm evaluation temporarily and clears the existing alarms once alarm limit per alarm rule is reached.", "type": "string", "enum": [ "Enabled", "Disabled", "SystemDisabled" ], "default": "Enabled", "x-omitempty": true }, "SystemDisabledTime": { "description": "The time at which AlarmRule object is system-disabled.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ThresholdDefinitionStates": { "type": "array", "items": { "description": "Collection of ThresholdDefinitionState which controls the behavior of alarm processing for the AlarmRule based on the state defined for ThresholdDefinition objects.", "$ref": "#/components/schemas/cond.ThresholdDefinitionState", "x-omitempty": true }, "nullable": true }, "Account": { "$ref": "#/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." }, "Devices": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true }, "ThresholdDefinitions": { "description": "An array of relationships to condThresholdDefinition resources.", "type": "array", "items": { "$ref": "#/components/schemas/cond.ThresholdDefinition.Relationship" }, "nullable": true } } } ] }, "cond.AlarmRule.List": { "title": "List of 'cond.AlarmRule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.AlarmRule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.AlarmRule' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.AlarmRule" }, "nullable": true } } } ] }, "cond.AlarmRuleExpression": { "title": "Cond:Alarm Rule Expression", "description": "A rule used to filter alarms. Alarms are specified using one or more groupings of\nproperty, operator and value.", "x-allOf-name": "cond.AlarmRuleExpression", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmRuleExpression', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmRuleExpression" ], "default": "cond.AlarmRuleExpression", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmRuleExpression" ], "default": "cond.AlarmRuleExpression", "x-enum-as-string": true }, "Operator": { "description": "The operator to apply. Operators supported are: eq, contains, in.", "type": "string", "x-omitempty": true }, "Property": { "description": "The property name keyword to filter on. For a list of supported property keywords\nsee the Intersight Help Center.", "type": "string", "x-omitempty": true }, "Value": { "type": "array", "items": { "description": "Values to match the property against. Must be a list of strings, with length 1 for\neq and contains operators, but can be any length for the in operator.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "cond.AlarmSpec": { "title": "Cond:Alarm Spec", "description": "A specification of the details used to construct an alarm instance.", "x-allOf-name": "cond.AlarmSpec", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmSpec', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmSpec" ], "default": "cond.AlarmSpec", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmSpec" ], "default": "cond.AlarmSpec", "x-enum-as-string": true }, "Severity": { "description": "The severity of the alarm.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "x-omitempty": true } } } ] }, "cond.AlarmSummary": { "title": "Cond:Alarm Summary", "description": "The summary of alarm counts based on alarm serverity.", "x-allOf-name": "cond.AlarmSummary", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.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": [ "cond.AlarmSummary" ], "default": "cond.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": [ "cond.AlarmSummary" ], "default": "cond.AlarmSummary", "x-enum-as-string": true }, "Critical": { "description": "The count of active 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 active alarms that have severity type Info.", "type": "integer", "format": "int64", "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 active alarms that have severity type Warning.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "cond.AlarmSuppression.Response": { "description": "The response body of a HTTP GET request for the 'cond.AlarmSuppression' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.AlarmSuppression' resources.", "x-one-of-name": "cond.AlarmSuppression.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.AlarmSuppression.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.AlarmSuppression.Relationship": { "description": "A relationship to the 'cond.AlarmSuppression' resource, or the expanded 'cond.AlarmSuppression' resource, or the 'null' value.", "x-one-of-name": "cond.AlarmSuppression.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/cond.AlarmSuppression" } ], "discriminator": { "propertyName": "ClassId" } }, "cond.AlarmSuppression": { "title": "Alarm Suppression", "description": "The AlarmSuppression is for selective suppression of alarms across various managed objects (MOs). It allows users to define which alarms should be hidden or suppressed, ensuring that only relevant alerts are visible and actionable.\n#### Purpose\nAlarmSuppression provides a mechanism to control and manage alarms by suppressing them at specific entity levels. This capability is essential for maintaining focus on critical alerts and minimizing unnecessary noise in alarm systems.\n#### Key Concepts\n- **Entity-Based Suppression:** Alarms can be suppressed directly at the MO level.\n- **Privilege-Based Access:** Access to create, update, and delete suppressions is governed by privilege sets, ensuring that only authorized users can modify alarm suppression settings.\n- **Operational Flexibility:** Suppressions can be tailored to specific server maintenance needs, allowing users to focus on critical alerts during maintenance windows.", "x-allOf-name": "cond.AlarmSuppression", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmSuppression', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmSuppression" ], "default": "cond.AlarmSuppression", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmSuppression" ], "default": "cond.AlarmSuppression", "x-enum-as-string": true }, "AlarmRules": { "type": "array", "items": { "description": "The list of rules that are used to filter the alarms. If any\nrules are populated, the entity relationship must not be set.", "$ref": "#/components/schemas/cond.AlarmRuleExpression", "x-omitempty": true }, "nullable": true }, "Description": { "description": "User given description on why the suppression is enabled at this entity.", "type": "string", "minLength": 0, "maxLength": 120, "x-omitempty": true }, "Enabled": { "description": "Indicates whether the suppression is enabled by the user or not. The user should be able to toggle this between true and false.\nThe property is set to true when the suppression is created. The user can set this to false to disable the suppression.\nThe suppression rule should be active only if both systemEnabled and enabled are true.", "type": "boolean", "default": true, "x-omitempty": true }, "EndDate": { "description": "The end date for this alarm suppression rule. The date must follow the RFC 3339 format for date and time representation.", "type": "string", "format": "date-time", "x-omitempty": true }, "Name": { "description": "The name that identifies the alarm suppression.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][\\w\\s.-]{1,255}$", "x-omitempty": true }, "OdataFilterInternal": { "description": "Odata filter string managed internally. It is built by combining all the rules.", "type": "string", "readOnly": true, "x-omitempty": true }, "RulesOperator": { "description": "Operation that binds all the different rules together.\n* `All` - All is an AND condition applied against the individual conditions.\n* `Any` - Any is an OR condition applied against the individual conditions.", "type": "string", "enum": [ "All", "Any" ], "default": "All", "x-omitempty": true }, "StartDate": { "description": "The start date for enabling this alarm suppression rule. The date must follow\nthe RFC 3339 format for date and time representation. If this date more than\n60 seconds in the past, the suppression rule will be rejected. If the date is\nwithin 60 seconds of the present time (plus or minus), the suppression will be\nstarted immediately. Otherwise, the suppression will be scheduled to start at\nthe requested time.", "type": "string", "format": "date-time", "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Classifications": { "description": "An array of relationships to condAlarmClassification resources.", "type": "array", "items": { "$ref": "#/components/schemas/cond.AlarmClassification.Relationship" }, "nullable": true }, "Entity": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "cond.AlarmSuppression.List": { "title": "List of 'cond.AlarmSuppression' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.AlarmSuppression' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.AlarmSuppression' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.AlarmSuppression" }, "nullable": true } } } ] }, "cond.AlarmSuppressionDryRun": { "title": "Alarm Suppression Dry Run", "description": "This API will return a list of alarms likely to be suppressed by a proposed rule.", "x-allOf-name": "cond.AlarmSuppressionDryRun", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmSuppressionDryRun', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmSuppressionDryRun" ], "default": "cond.AlarmSuppressionDryRun", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmSuppressionDryRun" ], "default": "cond.AlarmSuppressionDryRun", "x-enum-as-string": true }, "AlarmRules": { "type": "array", "items": { "description": "The list of rules the user wants to determine the impact of.", "$ref": "#/components/schemas/cond.AlarmRuleExpression", "x-omitempty": true }, "nullable": true }, "RulesOperator": { "description": "Operation that binds all the different rules together.\n* `All` - All is an AND condition applied against the individual conditions.\n* `Any` - Any is an OR condition applied against the individual conditions.", "type": "string", "enum": [ "All", "Any" ], "default": "All", "x-omitempty": true }, "Summary": { "description": "Returned by the server and contains the count and top alarms that would be impacted\nby the requested rule.", "$ref": "#/components/schemas/cond.AlarmSuppressionDryRunSummary", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "cond.AlarmSuppressionDryRunSummary": { "title": "Cond:Alarm Suppression Dry Run Summary", "description": "Contains both the total count of alarms that would be impacted by an evaluated\nsuppression rule, and a list of some of the alarms that might be suppressed.\nThis API accepts only the POST method. The $top query argument is optional, and\ncontrols the number of preview items returned. Values from 0 to 200 (inclusive)\nare permitted.", "x-allOf-name": "cond.AlarmSuppressionDryRunSummary", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.AlarmSuppressionDryRunSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.AlarmSuppressionDryRunSummary" ], "default": "cond.AlarmSuppressionDryRunSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.AlarmSuppressionDryRunSummary" ], "default": "cond.AlarmSuppressionDryRunSummary", "x-enum-as-string": true }, "Count": { "description": "The count of alarms that would be impacted by the proposed suppression rule.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TopAlarms": { "type": "array", "items": { "description": "Contains the preview fields of alarms to be suppressed.", "$ref": "#/components/schemas/cond.AlarmPreview", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "cond.CustomHclBaseline.Response": { "description": "The response body of a HTTP GET request for the 'cond.CustomHclBaseline' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.CustomHclBaseline' resources.", "x-one-of-name": "cond.CustomHclBaseline.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.CustomHclBaseline.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.CustomHclBaseline.Relationship": { "description": "A relationship to the 'cond.CustomHclBaseline' resource, or the expanded 'cond.CustomHclBaseline' resource, or the 'null' value.", "x-one-of-name": "cond.CustomHclBaseline.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/cond.CustomHclBaseline" } ], "discriminator": { "propertyName": "ClassId" } }, "cond.CustomHclBaseline": { "title": "Cond:Custom Hcl Baseline", "description": "The CustomHclBaseline object defines baseline configurations for Cisco servers within an organization. It allows administrators to specify hardware and software requirements that servers must meet to be considered compliant with organizational standards.\n#### Purpose\nCustomHclBaseline serves as a framework for establishing and enforcing baseline configurations, ensuring that servers adhere to defined hardware and software criteria. This helps maintain consistency, reliability, and performance across the organization's server infrastructure.\n#### Key Concepts\n- **Baseline Configuration:** Defines specific hardware and software parameters that servers must meet.\n- **Compliance Monitoring:** Tracks the compliance status of servers against the defined baseline configurations.", "x-allOf-name": "cond.CustomHclBaseline", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.CustomHclBaseline', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.CustomHclBaseline" ], "default": "cond.CustomHclBaseline", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.CustomHclBaseline" ], "default": "cond.CustomHclBaseline", "x-enum-as-string": true }, "Adapters": { "type": "array", "items": { "description": "Adapter details of the server like model, type, driver name , firmware and driver version.", "$ref": "#/components/schemas/cond.AdapterDetail", "x-omitempty": true }, "minItems": 0, "maxItems": 20, "nullable": true }, "CompliantServerCount": { "description": "The number of servers that are compliant with this custom Hcl baseline.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Description of the custom Hcl baseline.", "type": "string", "maxLength": 1024, "x-omitempty": true }, "Firmware": { "description": "The firmware version of currently running on the server.", "type": "string", "minLength": 0, "maxLength": 255, "x-omitempty": true }, "Generation": { "description": "It specifies the generation of the server. like M7, M8 etc.", "type": "string", "pattern": "^$|^M\\d+$", "x-omitempty": true }, "HclReason": { "description": "The reason of the current Cisco HCL status of the custom Hcl baseline.\n* `Missing-Os-Info` - This means the HclStatus for the server failed HCL validation because we have missing operating system information. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Incompatible-Components` - This means the HclStatus for the server failed HCL validation because one or more of its components failed validation. To see why components failed check the related HclStatusDetails.\n* `Compatible` - This means the HclStatus for the server has passed HCL validation for all of its related components.\n* `Not-Evaluated` - This means the HclStatus for the server has not been evaluated because it is exempted.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.\n* `Onboarding-Account` - This means the HclStatus for the server has not been evaluated because the server belongs to onboarding account.", "type": "string", "enum": [ "Missing-Os-Info", "Incompatible-Components", "Compatible", "Not-Evaluated", "Not-Applicable", "Onboarding-Account" ], "default": "Missing-Os-Info", "readOnly": true, "x-omitempty": true }, "HclStatus": { "description": "The Cisco HCL compatibility status of the custom Hcl baseline. The status can be one of the following \"Incomplete\" - there is not enough information to evaluate against the HCL data \"Validated\" - all components have been evaluated against the HCL and they all have \"Validated\" status \"Not-Listed\" - all components have been evaluated against the HCL and one or more have \"Not-Listed\" status. \"Not-Evaluatecustom Hcl d\" - The provided is insufficient for HCL status evaluation or the server is exempted from HCL validation \"Not-Applicable\" - the custom Hcl baseline is not applicable to the server.\n* `Incomplete` - This means we do not have operating system information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that in component's hardware or software profile was not found in the HCL.\n* `Not-Listed` - At the HclStatus level, this means that some part of the HCL validation has failed. This could be that either the server's hardware or software profile was not listed in the HCL or one of the components' hardware or software profile was not found in the HCL.\n* `Validated` - At the HclStatus level, this means that all of the components have passed validation. At HclStatusDetail level, this means that the component's hardware or software profile was found in the HCL.\n* `Not-Evaluated` - At the HclStatus level this means that this means that SW or Component status has not been evaluated as the previous evaluation step has not passed yet or the configurations provided are insufficient for HCL status assessment. At the HclStatusDetail level this means that either HW or SW status has not been evaluted because a previous evaluation step has not passed yet.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.", "type": "string", "enum": [ "Incomplete", "Not-Found", "Not-Listed", "Validated", "Not-Evaluated", "Not-Applicable" ], "default": "Incomplete", "readOnly": true, "x-omitempty": true }, "ManagementMode": { "description": "The management mode at which server is connected to intersight.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the custom Hcl baseline.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_-]{1,64}$", "minLength": 1, "maxLength": 64, "x-omitempty": true }, "NonCompliantServerCount": { "description": "The number of servers that are non-compliant with this custom Hcl baseline.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OperationState": { "description": "Operation state specifies the state of custom Hcl baseline whether the server's baseline status is evaluated or not. \"InProgress\" - Server's baseline status assessment is currently in progress \"Pending\" - Server's baseline status assessment is not yet started \"Active\" - Server's baseline status assessment is completed.\n* `Pending` - Server's custom hcl status assessment is not yet started.\n* `Active` - Server's custom hcl status assessment is completed.\n* `InProgress` - Server's custom hcl status assessment is currently in progress.\n* `Failed` - Server's custom hcl status assessment is failed.", "type": "string", "enum": [ "Pending", "Active", "InProgress", "Failed" ], "default": "Pending", "readOnly": true, "x-omitempty": true }, "OsVendor": { "description": "The operating system vendor name running on the server.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_ -]+$", "minLength": 0, "maxLength": 255, "x-omitempty": true }, "OsVersion": { "description": "Operating System version running on the server.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_ .()-]+$", "minLength": 0, "maxLength": 255, "x-omitempty": true }, "ProcessorFamily": { "description": "The processor family associated with the server for example processor model Intel (R) Xeon (R) Platinum 8454H or AMD EPYC 9654. will be validated using its corresponding processor family. Processor model Intel (R) Xeon (R) Platinum 8454H -> 4th Gen Intel Xeon Processor Scalable Family Processor model AMD EPYC 9654 -> 4th Gen AMD EPYC 9004 Series Processors.", "type": "string", "minLength": 0, "maxLength": 255, "x-omitempty": true }, "ServerModel": { "type": "array", "items": { "description": "The server model or product Id like UCSC-C240-M7SX.", "type": "string", "x-omitempty": true }, "minItems": 0, "maxItems": 10, "nullable": true }, "Organization": { "$ref": "#/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 } } } ] }, "cond.CustomHclBaseline.List": { "title": "List of 'cond.CustomHclBaseline' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.CustomHclBaseline' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.CustomHclBaseline' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.CustomHclBaseline" }, "nullable": true } } } ] }, "cond.CustomHclStatus.Response": { "description": "The response body of a HTTP GET request for the 'cond.CustomHclStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.CustomHclStatus' resources.", "x-one-of-name": "cond.CustomHclStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.CustomHclStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.CustomHclStatus": { "title": "Cond:Custom Hcl Status", "description": "The CustomHclStatus object represents the compliance status of a Cisco server against defined Custom Hcl baseline within an organization. It contains detailed insights into whether a server meets the specified hardware and software criteria set forth in the baseline.\n#### Purpose\nCustomHclStatus is crucial for monitoring and managing server compliance with organizational standards. It helps administrators identify non-compliant servers, understand the reasons for non-compliance, and take corrective actions to ensure that all servers adhere to the established custom Hcl baselines.\n#### Key Concepts\n- **Compliance Status:** Indicates whether a server is compliant or non-compliant with defined custom Hcl baselines.\n- **Detailed Properties:** Includes various properties such as server model, generation, firmware, operating system details, and more for comprehensive status reporting.\n- **Relationships:** Links to managed objects and custom Hcl baselines to provide context for compliance evaluations.", "x-allOf-name": "cond.CustomHclStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.CustomHclStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.CustomHclStatus" ], "default": "cond.CustomHclStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.CustomHclStatus" ], "default": "cond.CustomHclStatus", "x-enum-as-string": true }, "Adapters": { "type": "array", "items": { "description": "Adapter details of the server like model, type, driver name , firmware and driver version.", "$ref": "#/components/schemas/cond.AdapterInstance", "x-omitempty": true }, "nullable": true }, "BaselineStatusDetails": { "type": "array", "items": { "description": "The baseline status details of a server for a defined custom Hcl baseline within an organization.", "$ref": "#/components/schemas/cond.ServerBaselineStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "CiscoHclStatus": { "description": "The HCL compatibility status of the server. The status can be one of the following \"Incomplete\" - there is no enough information to evaluate against the HCL data \"Validated\" - all components have been evaluated against the HCL and they all have \"Validated\" status \"Not-Listed\" - all components have been evaluated against the HCL and one or more have \"Not-Listed\" status. \"Not-Evaluated\" - The server was not evaluated against the HCL because it is exempcustom Hcl t or the provided is insufficient for HCL status assessment.\n* `Incomplete` - This means we do not have operating system information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that in component's hardware or software profile was not found in the HCL.\n* `Not-Listed` - At the HclStatus level, this means that some part of the HCL validation has failed. This could be that either the server's hardware or software profile was not listed in the HCL or one of the components' hardware or software profile was not found in the HCL.\n* `Validated` - At the HclStatus level, this means that all of the components have passed validation. At HclStatusDetail level, this means that the component's hardware or software profile was found in the HCL.\n* `Not-Evaluated` - At the HclStatus level this means that this means that SW or Component status has not been evaluated as the previous evaluation step has not passed yet or the configurations provided are insufficient for HCL status assessment. At the HclStatusDetail level this means that either HW or SW status has not been evaluted because a previous evaluation step has not passed yet.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.", "type": "string", "enum": [ "Incomplete", "Not-Found", "Not-Listed", "Validated", "Not-Evaluated", "Not-Applicable" ], "default": "Incomplete", "readOnly": true, "x-omitempty": true }, "CustomHclStatus": { "description": "The custom HCL overall status against all the defined custom Hcl baseline. The status can be one of the following \"CompliantToBaseline\" - The server is compliant to one or all the defined custom Hcl baseline. \"NonCompliantToBaseline\" - The server is non compliant to any custom Hcl baseline.\n* `NonCompliantToBaseline` - The server is non compliant to any custom Hcl baseline.\n* `CompliantToBaseline` - The server is compliant to one or all the defined custom Hcl baseline.", "type": "string", "enum": [ "NonCompliantToBaseline", "CompliantToBaseline" ], "default": "NonCompliantToBaseline", "readOnly": true, "x-omitempty": true }, "Firmware": { "description": "The firmware version currently running on the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Generation": { "description": "It specifies the generation of the server like M6, M7, M8 etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManagementMode": { "description": "The management mode through which the server is connected to Intersight, such as standalone or managed mode.\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": "It specifies the server name or model.", "type": "string", "readOnly": true, "x-omitempty": true }, "OsVendor": { "description": "The operating System vendor of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "OsVersion": { "description": "The operating System version of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Personality": { "description": "Unique identity of added software personality.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProcessorFamily": { "description": "The processor family of the specified processor model associated with the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProcessorModel": { "description": "The processor model associated with the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerModel": { "description": "It specifies the server model or Product ID (PID).", "type": "string", "readOnly": true, "x-omitempty": true }, "CompliantBaseline": { "description": "An array of relationships to condCustomHclBaseline resources.", "type": "array", "items": { "$ref": "#/components/schemas/cond.CustomHclBaseline.Relationship" }, "nullable": true, "readOnly": true }, "ManagedObject": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/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." }, "NonCompliantBaseline": { "description": "An array of relationships to condCustomHclBaseline resources.", "type": "array", "items": { "$ref": "#/components/schemas/cond.CustomHclBaseline.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "#/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 } } } ] }, "cond.CustomHclStatus.List": { "title": "List of 'cond.CustomHclStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.CustomHclStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.CustomHclStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.CustomHclStatus" }, "nullable": true } } } ] }, "cond.FilterRule": { "title": "Cond:Filter Rule", "description": "Rule used to filter the alarms based on the severity type.", "x-allOf-name": "cond.FilterRule", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.FilterRule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.FilterRule" ], "default": "cond.FilterRule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.FilterRule" ], "default": "cond.FilterRule", "x-enum-as-string": true }, "Operator": { "description": "The operator to apply. Operators supported are: eq, contains, in.", "type": "string", "x-omitempty": true }, "Property": { "description": "The property name to filter on (e.g., HostName, Domain, Affected Endpoint, Alarm Code).", "type": "string", "x-omitempty": true }, "Value": { "type": "array", "items": { "description": "Values to match the property against. Must be a list of strings, with length 1 for\neq and contains operators, but can be any length for the in operator.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "cond.HclStatus.Response": { "description": "The response body of a HTTP GET request for the 'cond.HclStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.HclStatus' resources.", "x-one-of-name": "cond.HclStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.HclStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.HclStatus.Relationship": { "description": "A relationship to the 'cond.HclStatus' resource, or the expanded 'cond.HclStatus' resource, or the 'null' value.", "x-one-of-name": "cond.HclStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/cond.HclStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "cond.HclStatus": { "title": "Cond:Hcl Status", "description": "The HCL Status stores the Hardware Compatibility List (HCL) validation status of servers. It evaluates the compatibility of Cisco Servers by checking if the hardware and software components\u2014such as server model, processor, firmware, adapters, operating system, and drivers\u2014have been tested and validated by Cisco or its partners.\n#### Purpose\nHclStatus ensures that server components are compatible with the HCL, safeguarding the reliability and performance of hardware and software integrations. It facilitates the evaluation of Cisco servers, ensuring they meet established standards.\n#### Key Concepts\n- **Compatibility Validation:** Evaluates and reports on the compatibility status of server components with the HCL.\n- **Status Reporting:** Provides detailed statuses such as \"Validated\", \"Not-Listed\", and \"Incomplete\" offering clear insights into compatibility.\n- **Reason Enumeration:** Offers reasons for validation outcomes, aiding in troubleshooting and compliance checks.\n- **Relationship Management:** Integrates with related components and devices for comprehensive validation reporting.", "x-allOf-name": "cond.HclStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.HclStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.HclStatus" ], "default": "cond.HclStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.HclStatus" ], "default": "cond.HclStatus", "x-enum-as-string": true }, "ComponentStatus": { "description": "The overall status for the components found in the HCL. This will provide the HCL validation status for all the components. It can be one of the following. \"Validated\" - all the components hardware/software profiles are listed in the HCL. \"Not-Listed\" - one or more components hardware/software profiles are not listed in the HCL \"Incomplete\" - the components are not evaluated as the server's software/hardware profiles are not listed in the HCL. \"Not-Evaluated\" - The components are not evaluated against the HCL because it is exempted.\n* `Incomplete` - This means we do not have operating system information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that in component's hardware or software profile was not found in the HCL.\n* `Not-Listed` - At the HclStatus level, this means that some part of the HCL validation has failed. This could be that either the server's hardware or software profile was not listed in the HCL or one of the components' hardware or software profile was not found in the HCL.\n* `Validated` - At the HclStatus level, this means that all of the components have passed validation. At HclStatusDetail level, this means that the component's hardware or software profile was found in the HCL.\n* `Not-Evaluated` - At the HclStatus level this means that this means that SW or Component status has not been evaluated as the previous evaluation step has not passed yet or the configurations provided are insufficient for HCL status assessment. At the HclStatusDetail level this means that either HW or SW status has not been evaluted because a previous evaluation step has not passed yet.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.", "type": "string", "enum": [ "Incomplete", "Not-Found", "Not-Listed", "Validated", "Not-Evaluated", "Not-Applicable" ], "default": "Incomplete", "readOnly": true, "x-omitempty": true }, "Generation": { "description": "The generation of the server model.", "type": "string", "readOnly": true, "x-omitempty": true }, "HardwareStatus": { "description": "The server model, processor and firmware are considered as part of the hardware profile for the server. This will provide the HCL validation status for the hardware profile. For the failure reason see the serverReason property. The status can be one of the following \"Validated\" - The server model, processor and firmware combination is listed in the HCL \"Not-Listed\" - The server model, processor and firmware combination is not listed in the HCL. \"Not-Evaluated\" - The server is not evaluated against the HCL because it is exempted.\n* `Incomplete` - This means we do not have operating system information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that in component's hardware or software profile was not found in the HCL.\n* `Not-Listed` - At the HclStatus level, this means that some part of the HCL validation has failed. This could be that either the server's hardware or software profile was not listed in the HCL or one of the components' hardware or software profile was not found in the HCL.\n* `Validated` - At the HclStatus level, this means that all of the components have passed validation. At HclStatusDetail level, this means that the component's hardware or software profile was found in the HCL.\n* `Not-Evaluated` - At the HclStatus level this means that this means that SW or Component status has not been evaluated as the previous evaluation step has not passed yet or the configurations provided are insufficient for HCL status assessment. At the HclStatusDetail level this means that either HW or SW status has not been evaluted because a previous evaluation step has not passed yet.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.", "type": "string", "enum": [ "Incomplete", "Not-Found", "Not-Listed", "Validated", "Not-Evaluated", "Not-Applicable" ], "default": "Incomplete", "readOnly": true, "x-omitempty": true }, "HclFirmwareVersion": { "description": "The current CIMC version for the server normalized for querying HCL data. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclModel": { "description": "The managed object's model to validate normalized for querying HCL data. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclOsVendor": { "description": "The operating system Vendor for the managed object to validate normalized for querying HCL data. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclOsVersion": { "description": "The operating system Version for the managed object to validate normalized for querying HCL data. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclProcessor": { "description": "The managed object's processor to validate if applicable normalized for querying HCL data. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclValidationTime": { "description": "The time at which the last HCL validation occurred.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "InvFirmwareVersion": { "description": "The current CIMC version for the server as received from inventory. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvModel": { "description": "The managed object's model to validate as received from the inventory. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvOsVendor": { "description": "The operating system Vendor for the managed object to validate as received from inventory. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvOsVersion": { "description": "The operating system Version for the managed object to validate as received from inventory. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvProcessor": { "description": "The managed object's processor to validate if applicable as received from inventory. It is empty if we are missing this information.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManagementMode": { "description": "The management mode at which server is connected to intersight.\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 }, "Personality": { "description": "Unique identity of added software personality.", "type": "string", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "The reason for the HCL status. It will be one of the following \"Missing-Os-Info\" - we are missing operating system information in the inventory from the device connector \"Incompatible-Components\" - we have 1 or more components with \"Not-Validated\" status \"Compatible\" - all the components have \"Validated\" status. \"Not-Evaluated\" - The server is not evaluated against the HCL because it is exempted.\n* `Missing-Os-Info` - This means the HclStatus for the server failed HCL validation because we have missing operating system information. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Incompatible-Components` - This means the HclStatus for the server failed HCL validation because one or more of its components failed validation. To see why components failed check the related HclStatusDetails.\n* `Compatible` - This means the HclStatus for the server has passed HCL validation for all of its related components.\n* `Not-Evaluated` - This means the HclStatus for the server has not been evaluated because it is exempted.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.\n* `Onboarding-Account` - This means the HclStatus for the server has not been evaluated because the server belongs to onboarding account.", "type": "string", "enum": [ "Missing-Os-Info", "Incompatible-Components", "Compatible", "Not-Evaluated", "Not-Applicable", "Onboarding-Account" ], "default": "Missing-Os-Info", "readOnly": true, "x-omitempty": true }, "ServerName": { "description": "The name of the Rack server or Blade as specified in compute.RackUnit or compute.Blade Mo.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerReason": { "description": "The reason generated by the server's HCL validation. For HCL the evaluation can be seen in three logical stages 1. Evaluate the server's hardware status 2. Evaluate the server's software status 3. Evaluate the server's components (each component has its own hardware/software evaluation) The evaluation does not proceed to the next stage until the previous stage is evaluated. Therefore there can be only one validation reason. \"Incompatible-Server\" - the server model is not listed in the HCL. \"Incompatible-Processor\" - the server model and processor combination is not listed in HCL. \"Incompatible-Firmware\" - the server model, processor and server firmware is not listed in HCL. \"Missing-Os-Info\" - the operating system vendor and version is not listed in HCL with the HW profile. \"Incompatible-Os-Info\" - the operating system vendor and version is not listed in HCL with the HW profile. \"Incompatible-Components\" - there is one or more components with \"Not-Validated\" status \"Service-Unavailable\" - HCL data service is unavailable at the moment (try again later). \"Compatible\" - the server and all its components are validated. \"Not-Evaluated\" - The server is not evaluated against the HCL because it is exempted.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install UCS Tools VIB on the host ESXi or use OS Discovery Tool scripts to provide proper operating system information.\n* `Incompatible-Server` - The validation failed for this server because the server's model was not listed in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not listed for the given server model.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor or version was not listed in HCL for the server PID and processor combination.\n* `Incompatible-Firmware` - The validation failed because the given server firmware was not listed in the HCL for the given server PID, processor, operating system vendor and version.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has returned a service error or unrecognized result.\n* `Not-Evaluated` - This means the HclStatus for the server has not been evaluated because it is exempted.\n* `Incompatible-Components` - The validation has failed for this server because one or more components have \"Not-Listed\" status.\n* `Compatible` - The validation has passed for this server's model, processor, operating system vendor and version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Firmware", "Service-Unavailable", "Service-Error", "Not-Evaluated", "Incompatible-Components", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "SoftwareStatus": { "description": "The operating system vendor and version are considered part of the software profile for the server. This will provide the HCL validation status for the software profile. For the failure reason see the serverReason property. The status can be be one of the following \"Validated\" - The operating system vendor/version is listed in the HCL for the server model, processor and firmware \"Not-Listed\" - The operating system vendor/version is not listed in the HCL for the server model, processor and firmware \"Incomplete\" - The inventory is missing operating system vendor/version and HCL validation was not performed. \"Not-Evaluated\" - The server is not evaluated against the HCL because it is exempted.\n* `Incomplete` - This means we do not have operating system information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that in component's hardware or software profile was not found in the HCL.\n* `Not-Listed` - At the HclStatus level, this means that some part of the HCL validation has failed. This could be that either the server's hardware or software profile was not listed in the HCL or one of the components' hardware or software profile was not found in the HCL.\n* `Validated` - At the HclStatus level, this means that all of the components have passed validation. At HclStatusDetail level, this means that the component's hardware or software profile was found in the HCL.\n* `Not-Evaluated` - At the HclStatus level this means that this means that SW or Component status has not been evaluated as the previous evaluation step has not passed yet or the configurations provided are insufficient for HCL status assessment. At the HclStatusDetail level this means that either HW or SW status has not been evaluted because a previous evaluation step has not passed yet.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.", "type": "string", "enum": [ "Incomplete", "Not-Found", "Not-Listed", "Validated", "Not-Evaluated", "Not-Applicable" ], "default": "Incomplete", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The HCL compatibility status of the managed object. The status can be one of the following \"Incomplete\" - there is no enough information to evaluate against the HCL data \"Validated\" - all components have been evaluated against the HCL and they all have \"Validated\" status \"Not-Listed\" - all components have been evaluated against the HCL and one or more have \"Not-Listed\" status. \"Not-Evaluated\" - server is not evaluated against the HCL because it is exempted.\n* `Incomplete` - This means we do not have operating system information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that in component's hardware or software profile was not found in the HCL.\n* `Not-Listed` - At the HclStatus level, this means that some part of the HCL validation has failed. This could be that either the server's hardware or software profile was not listed in the HCL or one of the components' hardware or software profile was not found in the HCL.\n* `Validated` - At the HclStatus level, this means that all of the components have passed validation. At HclStatusDetail level, this means that the component's hardware or software profile was found in the HCL.\n* `Not-Evaluated` - At the HclStatus level this means that this means that SW or Component status has not been evaluated as the previous evaluation step has not passed yet or the configurations provided are insufficient for HCL status assessment. At the HclStatusDetail level this means that either HW or SW status has not been evaluted because a previous evaluation step has not passed yet.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.", "type": "string", "enum": [ "Incomplete", "Not-Found", "Not-Listed", "Validated", "Not-Evaluated", "Not-Applicable" ], "default": "Incomplete", "readOnly": true, "x-omitempty": true }, "Details": { "description": "An array of relationships to condHclStatusDetail resources.", "type": "array", "items": { "$ref": "#/components/schemas/cond.HclStatusDetail.Relationship" }, "nullable": true, "readOnly": true }, "ManagedObject": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/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.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "cond.HclStatus.List": { "title": "List of 'cond.HclStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.HclStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.HclStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.HclStatus" }, "nullable": true } } } ] }, "cond.HclStatusDetail.Response": { "description": "The response body of a HTTP GET request for the 'cond.HclStatusDetail' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.HclStatusDetail' resources.", "x-one-of-name": "cond.HclStatusDetail.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.HclStatusDetail.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.HclStatusDetail.Relationship": { "description": "A relationship to the 'cond.HclStatusDetail' resource, or the expanded 'cond.HclStatusDetail' resource, or the 'null' value.", "x-one-of-name": "cond.HclStatusDetail.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/cond.HclStatusDetail" } ], "discriminator": { "propertyName": "ClassId" } }, "cond.HclStatusDetail": { "title": "Cond:Hcl Status Detail", "description": "The HclStatusDetail object provides detailed validation information for each component's firmware and drivers against the Hardware Compatibility List (HCL). It complements the broader HclStatus object by breaking down validation results at a component level.\n#### Purpose\nHclStatusDetail is essential for providing granular insights into the compatibility of individual components, helping identify specific issues and validation failures. It aids in maintaining high standards of component compatibility within Cisco environments.\n#### Key Concepts\n- **Detailed Validation:** Offers component-specific validation results, such as \"Validated\" and \"Not-Validated\", for precise compatibility reporting.\n- **Status Reasoning:** Provides detailed reasons for validation outcomes, facilitating targeted troubleshooting.\n- **Integration:** Works alongside the HclStatus object to deliver comprehensive compatibility insights across server components.\n- **Access Control:** Establishes privilege sets for reading component validation details, supporting secure management.", "x-allOf-name": "cond.HclStatusDetail", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.HclStatusDetail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.HclStatusDetail" ], "default": "cond.HclStatusDetail", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.HclStatusDetail" ], "default": "cond.HclStatusDetail", "x-enum-as-string": true }, "HardwareStatus": { "description": "The model is considered as part of the hardware profile for the component. This will provide the HCL validation status for the hardware profile. The reasons can be one of the following \"Incompatible-Server-With-Component\" - the server model and component combination is not listed in HCL \"Incompatible-Firmware\" - The server's firmware is not listed for this component's hardware profile \"Incompatible-Component\" - the component's model is not listed in the HCL \"Service-Unavailable\" - HCL data service is unavailable at the moment (try again later). This could be due to HCL data updating \"Not-Evaluated\" - the hardware profile was not evaluated for the component because the server's hw/sw status is not listed or server is exempted. \"Compatible\" - this component's hardware profile is listed in the HCL.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor and version was not found in HCL for the server PID and processor combination.\n* `Incompatible-Component-Model` - The validation failed because the given Component model was not found in the HCL for the given server PID, processor, server Firmware and operating system vendor and version.\n* `Incompatible-Firmware` - The validation failed because the given server firmware or adapter firmware was not found in the HCL for the given server PID, processor, operating system vendor and version and component model.\n* `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version, server firmware and component firmware.\n* `Incompatible-Firmware-Driver` - The validation failed because the given component firmware and driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version and server firmware.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result.\n* `Unrecognized-Protocol` - The validation has failed for the HCL component because the HCL data service has return a validation reason that is unknown to this service. This reason is used as a default failure reason reason in case we cannot map the error reason received from the HCL data service unto one of the other enum values.\n* `Not-Evaluated` - The validation for the hardware or software HCL status was not yet evaluated because some previous validation had failed. For example if a server's hardware profile fails to validate with HCL, then the server's software status will not be evaluated.\n* `Compatible` - The validation has passed for this server PID, processor, operating system vendor and version, component model, component firmware and driver version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server-With-Component", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Component-Model", "Incompatible-Firmware", "Incompatible-Driver", "Incompatible-Firmware-Driver", "Service-Unavailable", "Service-Error", "Unrecognized-Protocol", "Not-Evaluated", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "HclCimcVersion": { "description": "The current CIMC version for the server normalized for querying HCL data.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclDriverName": { "description": "The current driver name of the component we are validating normalized for querying HCL data.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclDriverVersion": { "description": "The current driver version of the component we are validating normalized for querying HCL data.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclFirmwareVersion": { "description": "The current firmware version of the component model normalized for querying HCL data.", "type": "string", "readOnly": true, "x-omitempty": true }, "HclModel": { "description": "The component model we are trying to validate normalized for querying HCL data.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvCimcVersion": { "description": "The current CIMC version for the server as received from inventory.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvDriverName": { "description": "The current driver name of the component we are validating as received from inventory.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvDriverVersion": { "description": "The current driver version of the component we are validating as received from inventory.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvFirmwareVersion": { "description": "The current firmware version of the component model as received from inventory.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvModel": { "description": "The component model we are trying to validate as received from inventory.", "type": "string", "readOnly": true, "x-omitempty": true }, "InvVendor": { "description": "The vendor detail of the adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "The reason for the status. The reason can be one of \"Incompatible-Server-With-Component\" - HCL validation has failed because the server model is not validated with this component \"Incompatible-Processor\" - HCL validation has failed because the processor is not validated with this server \"Incompatible-Os-Info\" - HCL validation has failed because the operating system vendor and version is not validated with this server \"Incompatible-Component-Model\" - HCL validation has failed because the component model is not validated \"Incompatible-Firmware\" - HCL validation has failed because the component or server firmware version is not validated \"Incompatible-Driver\" - HCL validation has failed because the driver version is not validated \"Incompatible-Firmware-Driver\" - HCL validation has failed because the firmware version and driver version is not validated \"Missing-Os-Driver-Info\" - HCL validation was not performed because we are missing operating system driver information form the inventory \"Service-Unavailable\" - HCL data service is unavailable at the moment (try again later). This could be due to HCL data updating \"Service-Error\" - HCL data service is available but an error occurred when making the request or parsing the response \"Unrecognized-Protocol\" - This service does not recognize the reason code in the response from the HCL data service \"Compatible\" - this component's inventory data has \"Validated\" status with the HCL. \"Not-Evaluated\" - The component is not evaluated against the HCL because the server is exempted.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor and version was not found in HCL for the server PID and processor combination.\n* `Incompatible-Component-Model` - The validation failed because the given Component model was not found in the HCL for the given server PID, processor, server Firmware and operating system vendor and version.\n* `Incompatible-Firmware` - The validation failed because the given server firmware or adapter firmware was not found in the HCL for the given server PID, processor, operating system vendor and version and component model.\n* `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version, server firmware and component firmware.\n* `Incompatible-Firmware-Driver` - The validation failed because the given component firmware and driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version and server firmware.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result.\n* `Unrecognized-Protocol` - The validation has failed for the HCL component because the HCL data service has return a validation reason that is unknown to this service. This reason is used as a default failure reason reason in case we cannot map the error reason received from the HCL data service unto one of the other enum values.\n* `Not-Evaluated` - The validation for the hardware or software HCL status was not yet evaluated because some previous validation had failed. For example if a server's hardware profile fails to validate with HCL, then the server's software status will not be evaluated.\n* `Compatible` - The validation has passed for this server PID, processor, operating system vendor and version, component model, component firmware and driver version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server-With-Component", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Component-Model", "Incompatible-Firmware", "Incompatible-Driver", "Incompatible-Firmware-Driver", "Service-Unavailable", "Service-Error", "Unrecognized-Protocol", "Not-Evaluated", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "SoftwareStatus": { "description": "The firmware, driver name and driver version are considered as part of the software profile for the component. This will provide the HCL validation status for the software profile. The reasons can be one of the following \"Incompatible-Firmware\" - the component's firmware is not listed under the server's hardware and software profile and the component's hardware profile \"Incompatible-Driver\" - the component's driver is not listed under the server's hardware and software profile and the component's hardware profile \"Incompatible-Firmware-Driver\" - the component's firmware and driver are not listed under the server's hardware and software profile and the component's hardware profile \"Service-Unavailable\" - HCL data service is unavailable at the moment (try again later). This could be due to HCL data updating \"Not-Evaluated\" - the component's hardware status was not evaluated because the server's hardware or software profile is not listed or server is exempted. \"Compatible\" - this component's hardware profile is listed in the HCL.\n* `Missing-Os-Driver-Info` - The validation failed because the given server has no operating system driver information available in the inventory. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Incompatible-Server-With-Component` - The validation failed for this component because he server model and component model combination was not found in the HCL.\n* `Incompatible-Processor` - The validation failed because the given processor was not found for the given server PID.\n* `Incompatible-Os-Info` - The validation failed because the given operating system vendor and version was not found in HCL for the server PID and processor combination.\n* `Incompatible-Component-Model` - The validation failed because the given Component model was not found in the HCL for the given server PID, processor, server Firmware and operating system vendor and version.\n* `Incompatible-Firmware` - The validation failed because the given server firmware or adapter firmware was not found in the HCL for the given server PID, processor, operating system vendor and version and component model.\n* `Incompatible-Driver` - The validation failed because the given driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version, server firmware and component firmware.\n* `Incompatible-Firmware-Driver` - The validation failed because the given component firmware and driver version was not found in the HCL for the given Server PID, processor, operating system vendor and version and server firmware.\n* `Service-Unavailable` - The validation has failed because HCL data service is temporarily not available. The server will be re-evaluated once HCL data service is back online or finished importing new HCL data.\n* `Service-Error` - The validation has failed because the HCL data service has return a service error or unrecognized result.\n* `Unrecognized-Protocol` - The validation has failed for the HCL component because the HCL data service has return a validation reason that is unknown to this service. This reason is used as a default failure reason reason in case we cannot map the error reason received from the HCL data service unto one of the other enum values.\n* `Not-Evaluated` - The validation for the hardware or software HCL status was not yet evaluated because some previous validation had failed. For example if a server's hardware profile fails to validate with HCL, then the server's software status will not be evaluated.\n* `Compatible` - The validation has passed for this server PID, processor, operating system vendor and version, component model, component firmware and driver version.", "type": "string", "enum": [ "Missing-Os-Driver-Info", "Incompatible-Server-With-Component", "Incompatible-Processor", "Incompatible-Os-Info", "Incompatible-Component-Model", "Incompatible-Firmware", "Incompatible-Driver", "Incompatible-Firmware-Driver", "Service-Unavailable", "Service-Error", "Unrecognized-Protocol", "Not-Evaluated", "Compatible" ], "default": "Missing-Os-Driver-Info", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status for the component model, firmware version, driver name, and driver version after validating against the HCL. The status can be one of the following \"Unknown\" - we do not have enough information to evaluate against the HCL data \"Validated\" - we have validated this component against the HCL and it has \"Validated\" status \"Not-Validated\" - we have validated this component against the HCL and it has \"Not-Validated\" status. \"Not-Evaluated\" - The component is not evaluated against the HCL because the server is exempted.\n* `Incomplete` - This means we do not have operating system information in Intersight for this server. Either install ucstools vib or use power shell scripts to tag proper operating system information.\n* `Not-Found` - At HclStatus level, this means that one of the components has failed validation. At HclStatusDetail level, this means that in component's hardware or software profile was not found in the HCL.\n* `Not-Listed` - At the HclStatus level, this means that some part of the HCL validation has failed. This could be that either the server's hardware or software profile was not listed in the HCL or one of the components' hardware or software profile was not found in the HCL.\n* `Validated` - At the HclStatus level, this means that all of the components have passed validation. At HclStatusDetail level, this means that the component's hardware or software profile was found in the HCL.\n* `Not-Evaluated` - At the HclStatus level this means that this means that SW or Component status has not been evaluated as the previous evaluation step has not passed yet or the configurations provided are insufficient for HCL status assessment. At the HclStatusDetail level this means that either HW or SW status has not been evaluted because a previous evaluation step has not passed yet.\n* `Not-Applicable` - At the HclStatus level this means that the custom Hcl provided is not applicable to the server.", "type": "string", "enum": [ "Incomplete", "Not-Found", "Not-Listed", "Validated", "Not-Evaluated", "Not-Applicable" ], "default": "Incomplete", "readOnly": true, "x-omitempty": true }, "Component": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/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.", "readOnly": true }, "HclStatus": { "$ref": "#/components/schemas/cond.HclStatus.Relationship", "description": "A reference to a condHclStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "cond.HclStatusDetail.List": { "title": "List of 'cond.HclStatusDetail' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.HclStatusDetail' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.HclStatusDetail' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.HclStatusDetail" }, "nullable": true } } } ] }, "cond.HclStatusJob.Response": { "description": "The response body of a HTTP GET request for the 'cond.HclStatusJob' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.HclStatusJob' resources.", "x-one-of-name": "cond.HclStatusJob.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.HclStatusJob.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.HclStatusJob": { "title": "Cond:Hcl Status Job", "description": "The HclStatusJob object is utilized to batch inventory notifications and process evaluations of HclStatus. It ensures timely and efficient handling of compatibility checks within Cisco's hardware ecosystem.\n#### Purpose\nHclStatusJob is designed to manage and execute batch jobs related to hardware compatibility evaluations, ensuring that managed objects are consistently assessed against the HCL. It automates the processing of inventory updates to maintain compliance.\n#### Key Concepts\n- **Batch Processing:** Handles inventory notifications in batches, optimizing the evaluation of HclStatus.\n- **Automation:** Automates the assessment of compatibility, reducing manual intervention and enhancing efficiency.\n- **Relationship with Managed Objects:** Links directly with managed objects to facilitate seamless compatibility evaluations.\n- **Security:** Ensures evaluations are performed securely by inheriting permissions from related device registrations.", "x-allOf-name": "cond.HclStatusJob", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.HclStatusJob', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.HclStatusJob" ], "default": "cond.HclStatusJob", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.HclStatusJob" ], "default": "cond.HclStatusJob", "x-enum-as-string": true }, "ManagedObject": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/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." }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "cond.HclStatusJob.List": { "title": "List of 'cond.HclStatusJob' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.HclStatusJob' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.HclStatusJob' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.HclStatusJob" }, "nullable": true } } } ] }, "cond.ServerBaselineStatus": { "title": "Cond:Server Baseline Status", "description": "Server baseline status details.", "x-allOf-name": "cond.ServerBaselineStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.ServerBaselineStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.ServerBaselineStatus" ], "default": "cond.ServerBaselineStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.ServerBaselineStatus" ], "default": "cond.ServerBaselineStatus", "x-enum-as-string": true }, "AdapterCompliance": { "description": "Adapter compliance status of the server as per the referred custom Hcl baseline.\n* `NotApplicable` - Indicates that the custom Hcl baseline is not applicable to the server.\n* `Compliant` - Indicates that the server baseline status is validated and compliant with the defined custom Hcl baseline.\n* `NonCompliant` - Indicates that the server baseline status is not validated or does not meet the defined custom Hcl baseline.", "type": "string", "enum": [ "NotApplicable", "Compliant", "NonCompliant" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "AdapterReason": { "description": "Reason for the component status as per the referred custom Hcl baseline.\n* `NotApplicable` - Reason is not applicable for the specified baseline status.\n* `Compliant` - Custom Hcl Baseline properties are matched with server's properties.\n* `ServerModelNotMatched` - Server model of the server does not matched with custom Hcl baseline's server model.\n* `ProcessorNotMatched` - Processor of the server does not matched with custom Hcl baseline's processor.\n* `FirmwareVersionNotMatched` - Firmware version of the server does not matched with custom Hcl baseline's firmware version.\n* `ManagementModeNotMatched` - ManagementMode of the server does not matched with custom Hcl baseline's management mode.\n* `GenerationNotMatched` - Generation of the server does not matched with custom Hcl baseline's generation.\n* `PersonalityNotMatched` - Personality of the server does not matched with custom Hcl baseline's personality.\n* `OsVendorNotMatched` - Operating system vendor of the server does not matched with custom Hcl baseline's operating system vendor.\n* `OsVersionNotMatched` - Operating system version of the server does not matched with custom Hcl baseline's operating system version.\n* `AdapterModelNotMatched` - Adapter model of the server does not matched with custom Hcl baseline's adapter model.\n* `AdapterFirmwareNotMatched` - Adapter firmware version of the server does not matched with custom Hcl baseline's adapter adapter firmware version.\n* `AdapterTypeNotMatched` - Adapter Type of the server does not matched with custom Hcl baseline's adapter type.\n* `AdapterDriverProtocolNotMatched` - Adapter driver name of the server does not matched with custom Hcl baseline's adapter driver name.\n* `AdapterDriverVersionNotMatched` - Adapter driver version of the server does not matched with custom Hcl baseline's adapter driver version.\n* `AdapterNotMatched` - One or morecustom Hcl adapter of the server does not matched with custom Hcl baseline's adapter details.\n* `AdapterVendorNotMatched` - Adapter vendor of the server does not matched with custom Hcl baseline's adapter vendor.", "type": "string", "enum": [ "NotApplicable", "Compliant", "ServerModelNotMatched", "ProcessorNotMatched", "FirmwareVersionNotMatched", "ManagementModeNotMatched", "GenerationNotMatched", "PersonalityNotMatched", "OsVendorNotMatched", "OsVersionNotMatched", "AdapterModelNotMatched", "AdapterFirmwareNotMatched", "AdapterTypeNotMatched", "AdapterDriverProtocolNotMatched", "AdapterDriverVersionNotMatched", "AdapterNotMatched", "AdapterVendorNotMatched" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "AdaptersStatus": { "type": "array", "items": { "description": "The baseline status of all adapters associated with the server.", "$ref": "#/components/schemas/cond.AdapterBaselineStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "CustomHclBaseline": { "description": "Reference to the custom HCL baseline.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "HardwareCompliance": { "description": "Hardware compliance status of the server as per the referred custom Hcl baseline.\n* `NotApplicable` - Indicates that the custom Hcl baseline is not applicable to the server.\n* `Compliant` - Indicates that the server baseline status is validated and compliant with the defined custom Hcl baseline.\n* `NonCompliant` - Indicates that the server baseline status is not validated or does not meet the defined custom Hcl baseline.", "type": "string", "enum": [ "NotApplicable", "Compliant", "NonCompliant" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "HardwareReason": { "description": "Reason for the hardware status as per the referred custom Hcl baseline.\n* `NotApplicable` - Reason is not applicable for the specified baseline status.\n* `Compliant` - Custom Hcl Baseline properties are matched with server's properties.\n* `ServerModelNotMatched` - Server model of the server does not matched with custom Hcl baseline's server model.\n* `ProcessorNotMatched` - Processor of the server does not matched with custom Hcl baseline's processor.\n* `FirmwareVersionNotMatched` - Firmware version of the server does not matched with custom Hcl baseline's firmware version.\n* `ManagementModeNotMatched` - ManagementMode of the server does not matched with custom Hcl baseline's management mode.\n* `GenerationNotMatched` - Generation of the server does not matched with custom Hcl baseline's generation.\n* `PersonalityNotMatched` - Personality of the server does not matched with custom Hcl baseline's personality.\n* `OsVendorNotMatched` - Operating system vendor of the server does not matched with custom Hcl baseline's operating system vendor.\n* `OsVersionNotMatched` - Operating system version of the server does not matched with custom Hcl baseline's operating system version.\n* `AdapterModelNotMatched` - Adapter model of the server does not matched with custom Hcl baseline's adapter model.\n* `AdapterFirmwareNotMatched` - Adapter firmware version of the server does not matched with custom Hcl baseline's adapter adapter firmware version.\n* `AdapterTypeNotMatched` - Adapter Type of the server does not matched with custom Hcl baseline's adapter type.\n* `AdapterDriverProtocolNotMatched` - Adapter driver name of the server does not matched with custom Hcl baseline's adapter driver name.\n* `AdapterDriverVersionNotMatched` - Adapter driver version of the server does not matched with custom Hcl baseline's adapter driver version.\n* `AdapterNotMatched` - One or morecustom Hcl adapter of the server does not matched with custom Hcl baseline's adapter details.\n* `AdapterVendorNotMatched` - Adapter vendor of the server does not matched with custom Hcl baseline's adapter vendor.", "type": "string", "enum": [ "NotApplicable", "Compliant", "ServerModelNotMatched", "ProcessorNotMatched", "FirmwareVersionNotMatched", "ManagementModeNotMatched", "GenerationNotMatched", "PersonalityNotMatched", "OsVendorNotMatched", "OsVersionNotMatched", "AdapterModelNotMatched", "AdapterFirmwareNotMatched", "AdapterTypeNotMatched", "AdapterDriverProtocolNotMatched", "AdapterDriverVersionNotMatched", "AdapterNotMatched", "AdapterVendorNotMatched" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "Reason for the current baseline status.\n* `NotApplicable` - Reason is not applicable for the specified baseline status.\n* `Compliant` - Custom Hcl Baseline properties are matched with server's properties.\n* `ServerModelNotMatched` - Server model of the server does not matched with custom Hcl baseline's server model.\n* `ProcessorNotMatched` - Processor of the server does not matched with custom Hcl baseline's processor.\n* `FirmwareVersionNotMatched` - Firmware version of the server does not matched with custom Hcl baseline's firmware version.\n* `ManagementModeNotMatched` - ManagementMode of the server does not matched with custom Hcl baseline's management mode.\n* `GenerationNotMatched` - Generation of the server does not matched with custom Hcl baseline's generation.\n* `PersonalityNotMatched` - Personality of the server does not matched with custom Hcl baseline's personality.\n* `OsVendorNotMatched` - Operating system vendor of the server does not matched with custom Hcl baseline's operating system vendor.\n* `OsVersionNotMatched` - Operating system version of the server does not matched with custom Hcl baseline's operating system version.\n* `AdapterModelNotMatched` - Adapter model of the server does not matched with custom Hcl baseline's adapter model.\n* `AdapterFirmwareNotMatched` - Adapter firmware version of the server does not matched with custom Hcl baseline's adapter adapter firmware version.\n* `AdapterTypeNotMatched` - Adapter Type of the server does not matched with custom Hcl baseline's adapter type.\n* `AdapterDriverProtocolNotMatched` - Adapter driver name of the server does not matched with custom Hcl baseline's adapter driver name.\n* `AdapterDriverVersionNotMatched` - Adapter driver version of the server does not matched with custom Hcl baseline's adapter driver version.\n* `AdapterNotMatched` - One or morecustom Hcl adapter of the server does not matched with custom Hcl baseline's adapter details.\n* `AdapterVendorNotMatched` - Adapter vendor of the server does not matched with custom Hcl baseline's adapter vendor.", "type": "string", "enum": [ "NotApplicable", "Compliant", "ServerModelNotMatched", "ProcessorNotMatched", "FirmwareVersionNotMatched", "ManagementModeNotMatched", "GenerationNotMatched", "PersonalityNotMatched", "OsVendorNotMatched", "OsVersionNotMatched", "AdapterModelNotMatched", "AdapterFirmwareNotMatched", "AdapterTypeNotMatched", "AdapterDriverProtocolNotMatched", "AdapterDriverVersionNotMatched", "AdapterNotMatched", "AdapterVendorNotMatched" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "SoftwareCompliance": { "description": "Software compliance status of the server as per the referred custom Hcl baseline.\n* `NotApplicable` - Indicates that the custom Hcl baseline is not applicable to the server.\n* `Compliant` - Indicates that the server baseline status is validated and compliant with the defined custom Hcl baseline.\n* `NonCompliant` - Indicates that the server baseline status is not validated or does not meet the defined custom Hcl baseline.", "type": "string", "enum": [ "NotApplicable", "Compliant", "NonCompliant" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "SoftwareReason": { "description": "Reason for the software status as per referred custom Hcl baseline.\n* `NotApplicable` - Reason is not applicable for the specified baseline status.\n* `Compliant` - Custom Hcl Baseline properties are matched with server's properties.\n* `ServerModelNotMatched` - Server model of the server does not matched with custom Hcl baseline's server model.\n* `ProcessorNotMatched` - Processor of the server does not matched with custom Hcl baseline's processor.\n* `FirmwareVersionNotMatched` - Firmware version of the server does not matched with custom Hcl baseline's firmware version.\n* `ManagementModeNotMatched` - ManagementMode of the server does not matched with custom Hcl baseline's management mode.\n* `GenerationNotMatched` - Generation of the server does not matched with custom Hcl baseline's generation.\n* `PersonalityNotMatched` - Personality of the server does not matched with custom Hcl baseline's personality.\n* `OsVendorNotMatched` - Operating system vendor of the server does not matched with custom Hcl baseline's operating system vendor.\n* `OsVersionNotMatched` - Operating system version of the server does not matched with custom Hcl baseline's operating system version.\n* `AdapterModelNotMatched` - Adapter model of the server does not matched with custom Hcl baseline's adapter model.\n* `AdapterFirmwareNotMatched` - Adapter firmware version of the server does not matched with custom Hcl baseline's adapter adapter firmware version.\n* `AdapterTypeNotMatched` - Adapter Type of the server does not matched with custom Hcl baseline's adapter type.\n* `AdapterDriverProtocolNotMatched` - Adapter driver name of the server does not matched with custom Hcl baseline's adapter driver name.\n* `AdapterDriverVersionNotMatched` - Adapter driver version of the server does not matched with custom Hcl baseline's adapter driver version.\n* `AdapterNotMatched` - One or morecustom Hcl adapter of the server does not matched with custom Hcl baseline's adapter details.\n* `AdapterVendorNotMatched` - Adapter vendor of the server does not matched with custom Hcl baseline's adapter vendor.", "type": "string", "enum": [ "NotApplicable", "Compliant", "ServerModelNotMatched", "ProcessorNotMatched", "FirmwareVersionNotMatched", "ManagementModeNotMatched", "GenerationNotMatched", "PersonalityNotMatched", "OsVendorNotMatched", "OsVersionNotMatched", "AdapterModelNotMatched", "AdapterFirmwareNotMatched", "AdapterTypeNotMatched", "AdapterDriverProtocolNotMatched", "AdapterDriverVersionNotMatched", "AdapterNotMatched", "AdapterVendorNotMatched" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the server as per the referred custom Hcl baseline.\n* `NotApplicable` - Indicates that the custom Hcl baseline is not applicable to the server.\n* `Compliant` - Indicates that the server baseline status is validated and compliant with the defined custom Hcl baseline.\n* `NonCompliant` - Indicates that the server baseline status is not validated or does not meet the defined custom Hcl baseline.", "type": "string", "enum": [ "NotApplicable", "Compliant", "NonCompliant" ], "default": "NotApplicable", "readOnly": true, "x-omitempty": true }, "ValidationTime": { "description": "It specifies baseline status validation time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true } } } ] }, "cond.ThresholdDefinition.Response": { "description": "The response body of a HTTP GET request for the 'cond.ThresholdDefinition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'cond.ThresholdDefinition' resources.", "x-one-of-name": "cond.ThresholdDefinition.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/cond.ThresholdDefinition.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "cond.ThresholdDefinition.Relationship": { "description": "A relationship to the 'cond.ThresholdDefinition' resource, or the expanded 'cond.ThresholdDefinition' resource, or the 'null' value.", "x-one-of-name": "cond.ThresholdDefinition.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/cond.ThresholdDefinition" } ], "discriminator": { "propertyName": "ClassId" } }, "cond.ThresholdDefinition": { "title": "Cond:Threshold Definition", "description": "Defines the conditions to trigger a custom alarm. This has the information needed to construct and evaluate alarms.", "x-allOf-name": "cond.ThresholdDefinition", "allOf": [ { "$ref": "#/components/schemas/issue.Definition" }, { "type": "object", "description": "Definition of the list of properties defined in 'cond.ThresholdDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "cond.ThresholdDefinition" ], "default": "cond.ThresholdDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "cond.ThresholdDefinition" ], "default": "cond.ThresholdDefinition", "x-enum-as-string": true }, "Account": { "$ref": "#/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." } } } ] }, "cond.ThresholdDefinition.List": { "title": "List of 'cond.ThresholdDefinition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'cond.ThresholdDefinition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'cond.ThresholdDefinition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/cond.ThresholdDefinition" }, "nullable": true } } } ] }, "cond.ThresholdDefinitionState": { "title": "Cond:Threshold Definition State", "description": "Defines the state of ThresholdDefinition objects, enabling alarm processing to be customized according to the specific needs.", "x-allOf-name": "cond.ThresholdDefinitionState", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "connector.AuthMessage": { "title": "Connector:Auth Message", "description": "A base abstract message for connector messages that require authentication to be passed from the Intersight services.", "x-allOf-name": "connector.AuthMessage", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.AuthMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "connector.CommandControlMessage", "connector.XmlApiMessage", "imcconnector.WebUiMessage", "ucsdconnector.RestClientMessage" ], "x-enum-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": [ "connector.CommandControlMessage", "connector.XmlApiMessage", "imcconnector.WebUiMessage", "ucsdconnector.RestClientMessage" ], "x-enum-as-string": true }, "RemoteUserLocale": { "description": "The platform locale to assign user. A locale defines one or more organizations (domains) the user is allowed access to, and access is limited to the organizations specified in the locale.", "type": "string", "x-omitempty": true }, "RemoteUserName": { "description": "The user name passed to the platform for use in platform audit logs.", "type": "string", "x-omitempty": true }, "RemoteUserRoles": { "description": "The list of roles to pass to the platform to validate the action against.", "type": "string", "x-omitempty": true }, "RemoteUserSessionId": { "description": "The session Id passed to the platform for use in platform's auditing.", "type": "string", "x-omitempty": true } } } ] }, "connector.BaseMessage": { "title": "Connector:Base Message", "description": "A base abstract message that handles the common request properties applicable to all message types.", "x-allOf-name": "connector.BaseMessage", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.BaseMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "connector.CloseStreamMessage", "connector.CommandControlMessage", "connector.CommandTerminalStream", "connector.EventLog", "connector.FetchStreamMessage", "connector.FileMessage", "connector.HttpRequest", "connector.SshConfig", "connector.SshMessage", "connector.StartStream", "connector.StartStreamFromDevice", "connector.StreamAcknowledge", "connector.StreamInput", "connector.StreamKeepalive", "connector.TargetChangeMessage", "connector.WinrmRequest", "connector.XmlApiMessage", "imcconnector.WebUiMessage", "ucsdconnector.RestClientMessage", "workflow.FileTransfer", "workflow.SshCmd", "workflow.SshConfig" ], "x-enum-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": [ "connector.CloseStreamMessage", "connector.CommandControlMessage", "connector.CommandTerminalStream", "connector.EventLog", "connector.FetchStreamMessage", "connector.FileMessage", "connector.HttpRequest", "connector.SshConfig", "connector.SshMessage", "connector.StartStream", "connector.StartStreamFromDevice", "connector.StreamAcknowledge", "connector.StreamInput", "connector.StreamKeepalive", "connector.TargetChangeMessage", "connector.WinrmRequest", "connector.XmlApiMessage", "imcconnector.WebUiMessage", "ucsdconnector.RestClientMessage", "workflow.FileTransfer", "workflow.SshCmd", "workflow.SshConfig" ], "x-enum-as-string": true }, "EncryptedAesKey": { "description": "The secure properties that have large text content as value can be encrypted using AES key. In these cases, the AES key needs to be encrypted using the device connector's public key and passed as the value for this property.\nThe secure properties that are encrypted using the AES key are mapped against the property name with prefix 'AES' in SecureProperties dictionary.", "type": "string", "x-omitempty": true }, "EncryptionKey": { "description": "The public key that was used to encrypt the values present in SecureProperties dictionary.\nIf the given public key is not the same as device connector's public key, an error response with appropriate error message is thrown back.", "type": "string", "x-omitempty": true }, "SecureProperties": { "description": "A dictionary of encrypted secure values mapped against the secure property name. The values that are encrypted using the AES key must be mapped against the secure property name with an 'AES' prefix\nDevice connector expects the message body to be a golang template and the template can use the secure property names as placeholders.", "nullable": true, "x-omitempty": true } } } ] }, "connector.CacheStatus": { "title": "Connector:Cache Status", "description": "The status of a cache operation. The cache plugin will report the status of a caching operation periodically to report status or to report completion/error.", "x-allOf-name": "connector.CacheStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.CacheStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.UpgradeStatus" ], "default": "firmware.UpgradeStatus", "x-enum-as-string": true }, "CacheError": { "description": "Any error encountered in caching. Example, Space unavailability due to too many active workflows running.", "type": "string", "x-omitempty": true }, "CacheMessage": { "description": "Message to notify caching operation status.", "type": "string", "x-omitempty": true }, "CacheState": { "description": "The current cache status of the file.\n* `ReadyForImport` - The image is ready to be imported into the repository.\n* `Importing` - The image is being imported into the repository.\n* `Imported` - The image has been extracted and imported into the repository.\n* `ComputingMetadata` - Indicates that the image has been imported but its metadata computation has not been done.\n* `PendingExtraction` - Indicates that the image has been imported but not extracted in the repository.\n* `Extracting` - Indicates that the image is being extracted into the repository.\n* `Extracted` - Indicates that the image has been extracted into the repository.\n* `Failed` - The image import from an external source to the repository has failed.\n* `MetaOnly` - The image is present in an external repository.\n* `ReadyForCache` - The image is ready to be cached into the Intersight Appliance.\n* `Caching` - Indicates that the image is being cached into the Intersight Appliance or endpoint cache.\n* `Cached` - Indicates that the image has been cached into the Intersight Appliance or endpoint cache.\n* `CachingFailed` - Indicates that the image caching into the Intersight Appliance failed or endpoint cache.\n* `Corrupted` - Indicates that the image in the local repository (or endpoint cache) has been corrupted after it was cached.\n* `Evicted` - Indicates that the image has been evicted from the Intersight Appliance (or endpoint cache) to reclaim storage space.\n* `Invalid` - Indicates that the corresponding distributable MO has been removed from the backend. This can be due to unpublishing of an image.", "type": "string", "enum": [ "ReadyForImport", "Importing", "Imported", "ComputingMetadata", "PendingExtraction", "Extracting", "Extracted", "Failed", "MetaOnly", "ReadyForCache", "Caching", "Cached", "CachingFailed", "Corrupted", "Evicted", "Invalid" ], "default": "ReadyForImport", "x-omitempty": true }, "DownloadError": { "description": "Any error encountered. Set to empty when download is in progress or completed.", "type": "string", "x-omitempty": true }, "DownloadProgress": { "description": "The download progress of the file represented as a percentage between 0 and 100. If progress reporting is not possible, a value of -1 is sent.", "type": "integer", "format": "int64", "x-omitempty": true }, "DownloadRetries": { "description": "The number of retries the plugin attempted before succeeding or failing the download.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "connector.CloseStreamMessage": { "title": "Connector:Close Stream Message", "description": "Close a running stream. After close the stream will no longer emit events or be available to write to.", "x-allOf-name": "connector.CloseStreamMessage", "allOf": [ { "$ref": "#/components/schemas/connector.StreamMessage" } ] }, "connector.CommandControlMessage": { "title": "Connector:Command Control Message", "description": "A Command Message is sent from a cloud service to the connector's command plugin to execute a given command on the platform and begin tunneling input/output to/from the command.", "x-allOf-name": "connector.CommandControlMessage", "allOf": [ { "$ref": "#/components/schemas/connector.AuthMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.CommandControlMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.CommandControlMessage" ], "default": "connector.CommandControlMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.CommandControlMessage" ], "default": "connector.CommandControlMessage", "x-enum-as-string": true }, "Dir": { "description": "The working directory of the command. If empty, the command is executed in the same directory where the device connector process was called.", "type": "string", "x-omitempty": true }, "MsgType": { "description": "Message carrying the operation to perform.", "type": "string", "x-omitempty": true }, "Stream": { "description": "The command to execute. Commands must be in the list allowed by platform implementation, if a command does not match any allowed list command patterns, an error will be returned to the requesting service on command start.", "type": "string", "format": "byte", "x-omitempty": true }, "Terminal": { "description": "Indicates that a pseudo terminal should be attached to the command. Used for interactive commands, e.g a cross launch CLI.", "type": "boolean", "x-omitempty": true }, "Timeout": { "description": "The timeout for the command to complete and exit after starting or receiving input. If timeout is not set, a default of 10 minutes will be used. If there is input to the command stream, the timeout is extended.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "connector.CommandTerminalStream": { "title": "Connector:Command Terminal Stream", "description": "Holds the I/O of a terminal command session.", "x-allOf-name": "connector.CommandTerminalStream", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.CommandTerminalStream', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.CommandTerminalStream" ], "default": "connector.CommandTerminalStream", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.CommandTerminalStream" ], "default": "connector.CommandTerminalStream", "x-enum-as-string": true }, "MsgType": { "description": "The type of data this message contains.", "type": "string", "x-omitempty": true }, "Sequence": { "description": "Sequence of the message within a session to handle out-of-order delivery.", "type": "integer", "format": "int64", "x-omitempty": true }, "Stream": { "description": "The input/output payload to/from the pseudo terminal session. When sent from the cloud service, if the msgType is CommandInput, stream is piped to stdin of the command or a resize message, if msgType is CommandResize. From the device connector value is always the combined output of stdout & stderr.", "type": "string", "format": "byte", "x-omitempty": true } } } ] }, "connector.DownloadStatus": { "title": "Connector:Download Status", "description": "The status of a download operation. The download plugin will report the status of a download operation periodically to report status or to report completion/error.", "x-allOf-name": "connector.DownloadStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.DownloadStatus", "firmware.UnsupportedVersionUpgrade", "server.DiagnosticStatus", "softwarerepository.CachedImage" ], "x-enum-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.DownloadStatus", "firmware.UnsupportedVersionUpgrade", "server.DiagnosticStatus", "softwarerepository.CachedImage" ], "x-enum-as-string": true }, "Checksum": { "description": "The checksum of the downloaded file as calculated by the download plugin after successfully downloading a file.", "$ref": "#/components/schemas/connector.FileChecksum", "x-omitempty": true }, "DownloadError": { "description": "Any error encountered. Set to empty when download is in progress or completed.", "type": "string", "x-omitempty": true }, "DownloadProgress": { "description": "The download progress of the file represented as a percentage between 0% and 100%. If progress reporting is not possible, a value of -1 is sent.", "type": "integer", "format": "int64", "x-omitempty": true }, "DownloadRetries": { "description": "The number of retries the plugin attempted before succeeding or failing the download.", "type": "integer", "format": "int64", "x-omitempty": true }, "Sha256checksum": { "description": "The sha256checksum of the downloaded file as calculated by the download plugin after successfully downloading a file.", "type": "string", "format": "byte", "x-omitempty": true } } } ] }, "connector.EncryptionTaskMessage": { "title": "Connector:Encryption Task Message", "description": "An abstract message that handles properties required to receive encrypted data.", "x-allOf-name": "connector.EncryptionTaskMessage", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.EncryptionTaskMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "PublicEncryptionKey": { "description": "The public encryption key in PEM format to use to encrypt the data. Data should be encrypted using RSA-OAEP with SHA-256 hashing function. For example, a device can use this key to encrypt data securely at rest and to transport it securely to Intersight. Intersight has the capability to decrypt this data. The encrypted data should be base64 encoded into a string format for persistence/transit.", "type": "string", "x-omitempty": true } } } ] }, "connector.EventLog": { "title": "Connector:Event Log", "description": "A message to inform platform about any config changes.", "x-allOf-name": "connector.EventLog", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.EventLog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.EventLog" ], "default": "connector.EventLog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.EventLog" ], "default": "connector.EventLog", "x-enum-as-string": true }, "Contents": { "description": "Change contents of this event.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of the change event, e.g. connected, disconnected, claimed, unclaimed, etc.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "connector.ExpectPrompt": { "title": "Expect Prompt", "description": "This models a single expect and answer prompt of the interactive command.", "x-allOf-name": "connector.ExpectPrompt", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.ExpectPrompt', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.ExpectPrompt" ], "default": "connector.ExpectPrompt", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.ExpectPrompt" ], "default": "connector.ExpectPrompt", "x-enum-as-string": true }, "Expect": { "description": "The regex of the expect prompt of the interactive command.", "type": "string", "x-omitempty": true }, "ExpectTimeout": { "description": "The timeout for the expect prompt while executing an interactive command. If timeout is not set, a default of 60 seconds will be used.", "type": "integer", "format": "int64", "x-omitempty": true }, "Send": { "description": "The answer string to the expect prompt.", "type": "string", "x-omitempty": true } } } ] }, "connector.FetchStreamMessage": { "title": "Connector:Fetch Stream Message", "description": "Retrieve a list of cached stream messages by stream id. Cloud services will request stream messages to be re-sent in case of dropped messages (the cloud service receieves an unexpected stream sequence number). On success the device connector will 'replay' the messages, publishing them to the streams response topic, they will not be returned in the response to this message. If any of the requested sequences are not present in the cache an error will be returned.", "x-allOf-name": "connector.FetchStreamMessage", "allOf": [ { "$ref": "#/components/schemas/connector.StreamMessage" } ] }, "connector.FileChecksum": { "title": "Connector:File Checksum", "description": "A checksum value of a file's contents. Used to verify the integrity or equality of files on the file system.", "x-allOf-name": "connector.FileChecksum", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.FileChecksum', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.FileChecksum" ], "default": "connector.FileChecksum", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.FileChecksum" ], "default": "connector.FileChecksum", "x-enum-as-string": true }, "Hash": { "description": "The calculated hash of the contents using the algorithm.", "type": "string", "format": "byte", "x-omitempty": true }, "HashAlgorithm": { "description": "The hash algorithm used to calculate the checksum.\n* `crc` - A CRC hash as definded by RFC 3385. Generated with the IEEE polynomial.\n* `sha256` - An SHA256 hash as defined by RFC 4634.\n* `md5sum` - An MD5 hash as defined by RFC 1321.", "type": "string", "enum": [ "crc", "sha256", "md5sum" ], "default": "crc", "x-omitempty": true } } } ] }, "connector.FileMessage": { "title": "Connector:File Message", "description": "Message carries file operations to perform on the platform's file system. Cloud services can send a message to open and write to files on the connector platform's file system. Writes to a file can be buffered across many 'FileContent' messages, the file plugin will append to an open file as it receives file content until a close message is received.\nIf any operation fails (such as a file write returns error), an error will be returned to the cloud service and a best effort to close and remove the file will be made (if the file was previously opened).", "x-allOf-name": "connector.FileMessage", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.FileMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.FileMessage" ], "default": "connector.FileMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.FileMessage" ], "default": "connector.FileMessage", "x-enum-as-string": true }, "MsgType": { "description": "Message type carrying the file operation to perform.\n* `OpenFile` - Open a file for writing to on the platform's file system. Must be the first message sent to the plugin when writing files, attempting to write to or close a file that has not been opened will return error. If a file does not exist, it will be created, if it does exist, the file will be truncated. If the file's parent directory does not exist, an error will be returned.\n* `FileContent` - Carries content to write to an open file. The complete file content can be buffered across many FileContent messages, with each subsequent message received appending to the end of the file. If the total size of FileContent messages exceeds the file size limit of 5MB, the plugin will return an error and remove the opened file.\n* `CloseFile` - Close the file. Close message must be sent at the end of file transfer. If no close message is sent and no input is received after a timeout of 10 minutes, the file will be removed. After a CloseFile is received, no further FileContent messages will be accepted and will return error.\n* `DeleteFile` - Delete a file from the filesystem. If the file does not exist, operation is a no-op and no error is returned. The file must be within one of the platform's allowed writable directories.\n* `ListDir` - Open a directory and return a list of files in the directory. Does not recursively walk subdirectories, returns only the top level files in the directory. Output will be a list of json encoded FileInfos.\n* `` - Open a file and read the contents into a response message. The response message body is the entire contents of the file with no encoding or compression. If the file does not exist, an error will be returned. If the size of the file exceeds 500KB, an error will be returned without reading any file contents.\n* `PopulateRemoteTemplateFile` - Populates data driven template file with input values to generate textual output. Inputs are the path of the template file on the device and values to populate. An error will be returned if the file does not exist or if there is an error while executing the templates.\n* `GetFreeSpace` - Checks the disk space availability of folder and returns the free disk space in percentage. Output will be a list of encoded FileInfos.", "type": "string", "enum": [ "OpenFile", "FileContent", "CloseFile", "DeleteFile", "ListDir", "", "PopulateRemoteTemplateFile", "GetFreeSpace" ], "default": "OpenFile", "x-omitempty": true }, "Path": { "description": "The absolute path of the file to open on the platform's file system. Must be a sub-directory of a directory defined within the platform configuration's WriteableDirectories. The file system device to write to must also have sufficient free space to write to (<75% full). Must be set for each message that is sent.", "type": "string", "x-omitempty": true }, "Stream": { "description": "The stream of bytes to write to file when message type is FileContent. Ignored for OpenFile and CloseFile messages. This field holds the input values (key-value pairs) to be populated in the template file when message type is PopulateTemplateFile.", "type": "string", "format": "byte", "x-omitempty": true } } } ] }, "connector.HttpRequest": { "title": "Connector:Http Request", "description": "An HTTP request sent by a cloud service to be proxied through a device connector.", "x-allOf-name": "connector.HttpRequest", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.HttpRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.HttpRequest" ], "default": "connector.HttpRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.HttpRequest" ], "default": "connector.HttpRequest", "x-enum-as-string": true }, "AssetTargetMoid": { "description": "The Target endpoint Moid which is used to fetch the previously persisted Target information in Intersight to create HTTP request along with any authentication info specified.", "type": "string", "x-omitempty": true }, "Body": { "description": "Contents of the request body to send for PUT/PATCH/POST requests.", "type": "string", "format": "byte", "x-omitempty": true }, "Certificate": { "description": "An SSL certificate to use to authenticate the identity of the remote server if the target of the request is an HTTPS server. Format of the certificate is a PEM encoded x509 certificate.", "type": "string", "x-omitempty": true }, "DialTimeout": { "description": "The timeout for establishing the TCP connection to the target host. If not set, the request timeout value is used.", "type": "integer", "format": "int64", "x-omitempty": true }, "EndpointMoid": { "description": "The MO id of the asset.EndpointConnection this request is directed to. If set, plugin will insert connection details into the request, including credentials if defined.", "type": "string", "x-omitempty": true }, "Header": { "description": "Collection of key/value pairs to set in the request header.", "nullable": true, "x-omitempty": true }, "Internal": { "description": "The request is for an internal platform API that requires authentication to be inserted by the platform implementation.", "type": "boolean", "x-omitempty": true }, "Method": { "description": "Method specifies the HTTP method (GET, POST, PUT, etc.). For client requests an empty string means GET.", "type": "string", "x-omitempty": true }, "Timeout": { "description": "The timeout for the HTTP request to complete, from connection establishment to response body read complete. If not set, a default timeout of four minutes is used.", "type": "integer", "format": "int64", "x-omitempty": true }, "Url": { "description": "The URL detailing the request and remote server to proxy the request to.", "$ref": "#/components/schemas/connector.Url", "x-omitempty": true } } } ] }, "connector.PlatformParamBase": { "title": "Connector:Platform Param Base", "description": "Parameter object for Tech Support requests. PlatformParamBase is the base class for the platform-specific parameter types.", "x-allOf-name": "connector.PlatformParamBase", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "connector.ScopedInventory": { "title": "Connector:Scoped Inventory", "description": "Abstract object defined to handle scoped inventory for a set of objects identified by the query parameters defined in the properties. All vendor specific scoped inventory objects will inherit from this object and the scoped inventory framework will address the inventory collection.", "x-allOf-name": "connector.ScopedInventory", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.ScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "task.CatalystSdwanScopedInventory", "task.FabricMosScopedInventory", "task.HciScopedInventory", "task.HitachiScopedInventory", "task.HyperFlexManagementScopedInventory", "task.HyperflexScopedInventory", "task.MdsScopedInventory", "task.MdsSystemScopedInventory", "task.MerakiScopedInventory", "task.NetAppScopedInventory", "task.NexusScopedInventory", "task.NexusSystemScopedInventory", "task.NexusVlanScopedInventory", "task.PureFlashBladeScopedInventory", "task.PureScopedInventory", "task.ServerScopedInventory" ], "x-enum-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": [ "task.CatalystSdwanScopedInventory", "task.FabricMosScopedInventory", "task.HciScopedInventory", "task.HitachiScopedInventory", "task.HyperFlexManagementScopedInventory", "task.HyperflexScopedInventory", "task.MdsScopedInventory", "task.MdsSystemScopedInventory", "task.MerakiScopedInventory", "task.NetAppScopedInventory", "task.NexusScopedInventory", "task.NexusSystemScopedInventory", "task.NexusVlanScopedInventory", "task.PureFlashBladeScopedInventory", "task.PureScopedInventory", "task.ServerScopedInventory" ], "x-enum-as-string": true }, "Immediate": { "description": "Device will immediately collect the objects from the platform. If false, the device will wait for any in flight scheduled collections to complete first. Used to ensure that any long running collections do not delay the scoped collection result.", "type": "boolean", "x-omitempty": true }, "NamingProperty": { "description": "A property that uniquely identifies the object to be inventoried as a part of the scoped inventory.", "type": "string", "x-omitempty": true }, "Queries": { "description": "Set of queries to identify objects to be inventoried as part of this scoped inventory action.", "nullable": true, "x-omitempty": true }, "Type": { "description": "Type of the object for which scoped inventory needs to be run.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Values": { "type": "array", "items": { "description": "Set of values of the namingProperty. namingProperty and values will be used to evaluate the objects to be inventoried. For example: In order to inventory a volume. Type: storage.Volume NamingProperty: Name Values: [testVolume1].", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "connector.SshConfig": { "title": "Connector:Ssh Config", "description": "Carries the SSH session details for opening a new connection. Sent by cloud services with the OpenSession message.", "x-allOf-name": "connector.SshConfig", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.SshConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.SshConfig" ], "default": "connector.SshConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.SshConfig" ], "default": "connector.SshConfig", "x-enum-as-string": true }, "JumpHost": { "description": "A jump host for establishing a connection to a server. Plugin will first establish a connection to this server, then create a tunneled connection to the target host.", "type": "string", "x-omitempty": true }, "Passphrase": { "description": "Optional passphrase if provided while creating the private key.", "type": "string", "x-omitempty": true }, "Password": { "description": "Password to use in the connection credentials (if empty, the private key will be used).", "type": "string", "x-omitempty": true }, "Pkey": { "description": "The private key to use in the connection credentials (optional if password is given).", "type": "string", "format": "byte", "x-omitempty": true }, "PkeyString": { "description": "The private key to use in the connection credentials in string format.", "type": "string", "x-omitempty": true }, "Target": { "description": "The remote server to connect to.", "type": "string", "x-omitempty": true }, "User": { "description": "Username for the remote connection.", "type": "string", "x-omitempty": true } } } ] }, "connector.SshMessage": { "title": "Connector:Ssh Message", "description": "An SSH message for opening, closing, executing a command, fetching or writing a file to a remote server. Cloud services send this message to a connector's SSH plugin to open and execute operations on an SSH session.", "x-allOf-name": "connector.SshMessage", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.SshMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.SshMessage" ], "default": "connector.SshMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.SshMessage" ], "default": "connector.SshMessage", "x-enum-as-string": true }, "ExpectPrompts": { "type": "array", "items": { "description": "Array of prompts and answers necessary to execute an interactive SSH command.", "$ref": "#/components/schemas/connector.ExpectPrompt", "x-omitempty": true }, "nullable": true }, "MsgType": { "description": "The operation to execute on a new or existing session.", "type": "integer", "format": "int64", "x-omitempty": true }, "SessionId": { "description": "Unique Id of session to route messages to.", "type": "string", "x-omitempty": true }, "ShellPrompt": { "description": "The regex of the secure shell prompt.", "type": "string", "x-omitempty": true }, "Stream": { "description": "Input to the SSH operation to be executed, e.g. file contents to write.", "type": "string", "format": "byte", "x-omitempty": true }, "Timeout": { "description": "The timeout for the SSH command to complete and exit after starting or receiving input. If timeout is not set, a default of 10 minutes will be used.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "connector.StartStream": { "title": "Connector:Start Stream", "description": "Start a stream. Cloud services sends the configuration for a stream to be opened within this message. If there already exists a stream with the given ID the connector will return its current sequence number, or if the cloud requests the stream can be rebuilt from scratch.", "x-allOf-name": "connector.StartStream", "allOf": [ { "$ref": "#/components/schemas/connector.StreamMessage" } ] }, "connector.StartStreamFromDevice": { "title": "Connector:Start Stream From Device", "description": "Start a stream from the device connector. Message type sent from the device connector to Intersight to trigger a stream open.", "x-allOf-name": "connector.StartStreamFromDevice", "allOf": [ { "$ref": "#/components/schemas/connector.StreamMessage" } ] }, "connector.StreamAcknowledge": { "title": "Connector:Stream Acknowledge", "description": "Acknowledge a set of messages read from the device, on receipt device will drop the acknowledged messages from its cache.", "x-allOf-name": "connector.StreamAcknowledge", "allOf": [ { "$ref": "#/components/schemas/connector.StreamMessage" } ] }, "connector.StreamInput": { "title": "Connector:Stream Input", "description": "Write input to a running stream. Cloud services can send input to a running stream. e.g. input to a running pseudoterminal If the requested stream is not running and error will be returned.", "x-allOf-name": "connector.StreamInput", "allOf": [ { "$ref": "#/components/schemas/connector.StreamMessage" } ] }, "connector.StreamKeepalive": { "title": "Connector:Stream Keepalive", "description": "Keepalive message sent between service and device over lifetime of stream. Cloud services will configure device to emit message periodically. On receipt cloud service will send a response keepalive to the device. If no input/output or keepalive message is received on either side within a configured timeout the stream will be closed.", "x-allOf-name": "connector.StreamKeepalive", "allOf": [ { "$ref": "#/components/schemas/connector.StreamMessage" } ] }, "connector.StreamMessage": { "title": "Connector:Stream Message", "description": "The base message to be sent to the stream plugin. Carries information to route the message to the appropriate running stream or create a new stream.", "x-allOf-name": "connector.StreamMessage", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" } ] }, "connector.TargetChangeMessage": { "title": "Connector:Target Change Message", "description": "The message sent to the Appliance device connector when a Target is created, modified or deleted. Appliance device connector is expected to maintain a durable cache of relevent Target information such that it can perform inventory collection and change operations against the target without soliciting basic connectivity details from Intersight.", "x-allOf-name": "connector.TargetChangeMessage", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.TargetChangeMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.TargetChangeMessage" ], "default": "connector.TargetChangeMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.TargetChangeMessage" ], "default": "connector.TargetChangeMessage", "x-enum-as-string": true }, "ModStatus": { "description": "ModStatus indicates if the change message conveys a creation, modification or deletion of an Target instance.\n* `None` - The 'none' operation/state.Indicates a configuration profile has been deployed, and the desired configuration matches the actual device configuration.\n* `Created` - The 'create' operation/state.Indicates a configuration profile has been created and associated with a device, but the configuration specified in the profilehas not been applied yet. For example, this could happen when the user creates a server profile and has not deployed the profile yet.\n* `Modified` - The 'update' operation/state.Indicates some of the desired configuration changes specified in a profile have not been been applied to the associated device.This happens when the user has made changes to a profile and has not deployed the changes yet, or when the workflow to applythe configuration changes has not completed successfully.\n* `Deleted` - The 'delete' operation/state.Indicates a configuration profile has been been disassociated from a device and the user has not undeployed these changes yet.", "type": "string", "enum": [ "None", "Created", "Modified", "Deleted" ], "default": "None", "x-omitempty": true }, "ServiceType": { "description": "The name of the service to be deployed for the given target. If more than one service need to be deployed for a given target, multiple target change request is sent to Intersight Assist, each consists of one service type. It is different from the target type e.g., asset.OrchestrationService, asset.TerraformIntegrationService and asset.WorkloadOptimizerService are currently supported in Intersight Assist.", "type": "string", "x-omitempty": true }, "TargetDetails": { "description": "A Json-serialized representation of the 'configuration' portion of the Target instance. Ie the representation contains configuration properties like the target's connectivity information but not operation status. The representation include credential information, encrypted with the RSA public key of the Appliance device connector. Appliance device connector is the sole maintainer of the RSA private key and the only system component which is capable of interpreting the credential.", "nullable": true, "x-omitempty": true }, "TargetMoid": { "description": "The Moid identifying the Target instance being created, modified or deleted.", "type": "string", "x-omitempty": true }, "TargetSpecification": { "description": "Meta information about the target deployment i.e., docker image URL, memory and CPU limits. This allows Intersight to define supported docker image tag and customize resources for each target deployment.", "$ref": "#/components/schemas/connector.TargetSpecification", "x-omitempty": true } } } ] }, "connector.TargetSpecification": { "title": "Connector:Target Specification", "description": "Target deployment specification details to deploy target as a kube service. This allows Intersight to define supported docker image tag and customize resources for each target deployment.", "x-allOf-name": "connector.TargetSpecification", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.TargetSpecification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.TargetSpecification" ], "default": "connector.TargetSpecification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.TargetSpecification" ], "default": "connector.TargetSpecification", "x-enum-as-string": true }, "CpuLimit": { "description": "CPU limit assigned to the docker container. It is total amount of CPU time that a container can use every 100ms. A container cannot use more than its share of CPU time during this interval.", "type": "string", "x-omitempty": true }, "CpuRequest": { "description": "Requested CPU value for a docker container to run in Intersight Assist.", "type": "string", "x-omitempty": true }, "ImageTag": { "description": "Docker image tag used to define kubernetes deployment for each target. Image tag should be the complete URL. This image can be found locally in case of Intersight Appliance or can be pulled from Intersight cloud in Intersight Assist deployment.", "type": "string", "x-omitempty": true }, "MemoryLimit": { "description": "Intersight Assist prevents the docker container from using more than the configured memory limit. If a Container exceeds its memory limit, it might be terminated. If it is restartable, the kubelet will restart it, as with any other type of runtime failure.", "type": "string", "x-omitempty": true }, "MemoryRequest": { "description": "Requested memory value for a docker container to run in Intersight Assist.", "type": "string", "x-omitempty": true } } } ] }, "connector.Url": { "title": "Connector:Url", "description": "The URL to proxy the request to.", "x-allOf-name": "connector.Url", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.Url', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.Url" ], "default": "connector.Url", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.Url" ], "default": "connector.Url", "x-enum-as-string": true }, "ForceQuery": { "description": "Flag to append a query to the URL even if rawQuery is empty.", "type": "boolean", "x-omitempty": true }, "Fragment": { "description": "The fragment identifier component of a URI allows indirect identification of a secondary resource by reference to a primary resource and additional identifying information. The identified secondary resource may be some portion or subset of the primary resource, some view on representations of the primary resource, or some other resource defined or described by those representations. A fragment identifier component is indicated by the presence of a number sign (\"#\") character and terminated by the end of the URI.", "type": "string", "x-omitempty": true }, "Host": { "description": "The host name identifies the host that holds the resource. The host can be an IP or a hostname that is resolvable by the DNS server configured on the platform.", "type": "string", "x-omitempty": true }, "Opaque": { "description": "A URI is opaque if, and only if, it is absolute and its scheme-specific part does not begin with a slash character ('/'). An opaque URI has a scheme, a scheme-specific part, and possibly a fragment; all other components are undefined.", "type": "string", "x-omitempty": true }, "Path": { "description": "The path identifies the specific resource in the host that the web client wants to access. Value is the decoded form of the path. e.g. '/foo/bar'.", "type": "string", "x-omitempty": true }, "RawPath": { "description": "The URI encoded form of the path property. e.g. '%2Fapi%2Fv1%2F'.", "type": "string", "x-omitempty": true }, "RawQuery": { "description": "The query component, as defined in RFC 3986, contains non-hierarchical data that, along with data in the path component, serves to identify a resource within the scope of the URI's scheme and naming authority (if any). The query component is indicated by the first question mark character and terminated by a number sign character or by the end of the URI.\nThe rawQuery contains the URIs encoded query component, excluding the ? character.", "type": "string", "x-omitempty": true }, "Scheme": { "description": "The scheme identifies the protocol to be used to access the resource on the Internet. It can be HTTP (without SSL) or HTTPS (with SSL).", "type": "string", "x-omitempty": true } } } ] }, "connector.WinrmRequest": { "title": "Connector:Winrm Request", "description": "A WinRM message sent from a cloud service to be proxied through a device connector.\nEncapsulates the details needed to execute a powershell script against an Intersight claimed,\nWinRM enabled windows target.", "x-allOf-name": "connector.WinrmRequest", "allOf": [ { "$ref": "#/components/schemas/connector.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.WinrmRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.WinrmRequest" ], "default": "connector.WinrmRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.WinrmRequest" ], "default": "connector.WinrmRequest", "x-enum-as-string": true }, "AssetTargetMoid": { "description": "The Target endpoint Moid which is used to fetch the previously persisted Target information in Intersight.", "type": "string", "x-omitempty": true }, "Body": { "description": "Contains the file content to be copied or the script to be executed.", "type": "string", "format": "byte", "x-omitempty": true }, "Filename": { "description": "The absolute filename to which body is to be written to.\nThis field is ignored if the opType is ExecuteScript.", "type": "string", "x-omitempty": true }, "OpType": { "description": "The type of operation to be performed on the endpoint.\nFile copy and script execution are the possible options.\nOnly script execution is supported for now.\n* `ExecuteScript` - Executes the given script on the target windows machine.\n* `CopyToFile` - The plugin copies the body of the incoming message to the given location.", "type": "string", "enum": [ "ExecuteScript", "CopyToFile" ], "default": "ExecuteScript", "x-omitempty": true }, "SessionId": { "description": "A unique id to track long running script executions.\nEvery execution request is identified by a unique session id. Scripts that have longer execution\ntimes can be tracked to completion by using their unique session id.", "type": "string", "x-omitempty": true }, "Timeout": { "description": "The time within which the script execution must be completed.\nIf the script execution exceeds the given time limit an appropriate response is sent back\nto the calling service.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "connector.XmlApiMessage": { "title": "Connector:Xml Api Message", "description": "Carries an XML API request to an HTTP server running on the platform.", "x-allOf-name": "connector.XmlApiMessage", "allOf": [ { "$ref": "#/components/schemas/connector.AuthMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'connector.XmlApiMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "connector.XmlApiMessage" ], "default": "connector.XmlApiMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "connector.XmlApiMessage" ], "default": "connector.XmlApiMessage", "x-enum-as-string": true }, "WithAuth": { "description": "Flag to disable authentication bypassing. If set to true, a valid cookie/login is expected to be provided within the XML API request body.", "type": "boolean", "x-omitempty": true }, "XmlRequest": { "description": "The XML request body to proxy to the platform.", "type": "string", "x-omitempty": true } } } ] }, "content.BaseParameter": { "title": "BaseParameter", "description": "A Baseparameter is an abstract definition of specific value to be extracted from a given API or\ndevice response.\nThe BaseParameter object provides the name, type and content specific path, such as XPath or\nJSONPath, that points to the location of the parameter value in the content. Additional parameters\nnecessary to extract data based on content type needs to extend BaseParameter.", "x-allOf-name": "content.BaseParameter", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'content.BaseParameter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "content.Parameter", "content.TextParameter" ], "x-enum-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": [ "content.Parameter", "content.TextParameter" ], "x-enum-as-string": true }, "AcceptSingleValue": { "description": "The flag that allows single values in content to be extracted as a\nsingle element collection in case the parameter is of Collection type.\nThis flag is applicable for parameters of type Collection only.", "type": "boolean", "x-omitempty": true }, "ComplexType": { "description": "The name of the complex type definition in case this is a complex\nparameter. The content.Grammar object must have a complex type, content.ComplexType,\ndefined with the specified name in types collection property.", "type": "string", "x-omitempty": true }, "ItemType": { "description": "The type of the collection item in case this is a collection parameter.\n* `simple` - The parameter value to be extracted is of the type simple. All the common scalar typessuch as int, bool, string, etc are represented by the simple enum.\n* `string` - The parameter value to be extracted is of the string type.\n* `integer` - The parameter value to be extracted is of the number type.\n* `float` - The parameter value to be extracted is of the float number type.\n* `boolean` - The parameter value to be extracted is of the boolean type.\n* `json` - The parameter values to be extracted is of the generic JSON literal. JSON type is applicable only if the content to be parsed is of JSON type.\n* `complex` - The parameter value to be extracted is a complex parameter that itself isanother collection of simple/complex parameters.\n* `collection` - The parameter value to be extracted is a collection parameter whose item typeshall be either simple type or complex type.", "type": "string", "enum": [ "simple", "string", "integer", "float", "boolean", "json", "complex", "collection" ], "default": "simple", "x-omitempty": true }, "Name": { "description": "The name of the parameter.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true }, "Path": { "description": "The content specific path information that identifies the parameter\nvalue within the content. The value is usually a XPath or JSONPath or a\nregular expression in case of text content.", "type": "string", "x-omitempty": true }, "Secure": { "description": "The flag indicates if the extracted value is secure.\nThis flag is applicable for parameters of type String only.", "type": "boolean", "x-omitempty": true }, "Type": { "description": "The type of the parameter. Accepted values are simple, complex,\ncollection.\n* `simple` - The parameter value to be extracted is of the type simple. All the common scalar typessuch as int, bool, string, etc are represented by the simple enum.\n* `string` - The parameter value to be extracted is of the string type.\n* `integer` - The parameter value to be extracted is of the number type.\n* `float` - The parameter value to be extracted is of the float number type.\n* `boolean` - The parameter value to be extracted is of the boolean type.\n* `json` - The parameter values to be extracted is of the generic JSON literal. JSON type is applicable only if the content to be parsed is of JSON type.\n* `complex` - The parameter value to be extracted is a complex parameter that itself isanother collection of simple/complex parameters.\n* `collection` - The parameter value to be extracted is a collection parameter whose item typeshall be either simple type or complex type.", "type": "string", "enum": [ "simple", "string", "integer", "float", "boolean", "json", "complex", "collection" ], "default": "simple", "x-omitempty": true } } } ] }, "content.ComplexType": { "title": "Complex Type", "description": "If the given API/device response is a collection of items, each item and\nits properties can be modeled as a complex type.\nThe types are uniquely named within the grammar and provides the list of\nparameters to be extracted from each item. Name of the complex type can be\nused as the type of parameter that represents the complex value.", "x-allOf-name": "content.ComplexType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'content.ComplexType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "content.ComplexType" ], "default": "content.ComplexType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "content.ComplexType" ], "default": "content.ComplexType", "x-enum-as-string": true }, "Name": { "description": "The unique name of this complex type within the grammar specification.", "type": "string", "x-omitempty": true }, "Parameters": { "type": "array", "items": { "description": "The collection of parameters that are part of this complex type.", "$ref": "#/components/schemas/content.BaseParameter", "x-omitempty": true }, "nullable": true } } } ] }, "content.Parameter": { "title": "Parameter", "description": "Concrete implementation of BaseParameter for XML and JSON content types.", "x-allOf-name": "content.Parameter", "allOf": [ { "$ref": "#/components/schemas/content.BaseParameter" } ] }, "content.TextParameter": { "title": "Content:Text Parameter", "description": "Concrete implementation of BaseParameter for Text content.", "x-allOf-name": "content.TextParameter", "allOf": [ { "$ref": "#/components/schemas/content.BaseParameter" }, { "type": "object", "description": "Definition of the list of properties defined in 'content.TextParameter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "content.TextParameter" ], "default": "content.TextParameter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "content.TextParameter" ], "default": "content.TextParameter", "x-enum-as-string": true }, "IsDelimiter": { "description": "Data to be extracted from text content can be simple type or complex type or collection of\nsimple/complex types. Complex types are group of simple or complex type.\nDelimiter is required to stop parsing list and complex data types.\nisDelimiter specifies whether given TextParameter is a delimiter or regular rule to capture\nthe text data.", "type": "boolean", "default": false, "x-omitempty": true }, "IsNextCaptureOnSameLine": { "description": "Set to true of the next value to capture resides on the same text line of current match.\nBy default textFSM engine gets the next text line on finding the first match.", "type": "boolean", "default": false, "x-omitempty": true }, "RegexLine": { "description": "Regular expression of the line containing the data to be extracted from text content.", "type": "string", "x-omitempty": true } } } ] }, "coremanagement.CoreFile.Response": { "description": "The response body of a HTTP GET request for the 'coremanagement.CoreFile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'coremanagement.CoreFile' resources.", "x-one-of-name": "coremanagement.CoreFile.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/coremanagement.CoreFile.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "coremanagement.CoreFile.Relationship": { "description": "A relationship to the 'coremanagement.CoreFile' resource, or the expanded 'coremanagement.CoreFile' resource, or the 'null' value.", "x-one-of-name": "coremanagement.CoreFile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/coremanagement.CoreFile" } ], "discriminator": { "propertyName": "ClassId" } }, "coremanagement.CoreFile": { "title": "Coremanagement:Core File", "description": "Core file meta data for individual core files on device.", "x-allOf-name": "coremanagement.CoreFile", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'coremanagement.CoreFile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "coremanagement.CoreFile" ], "default": "coremanagement.CoreFile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "coremanagement.CoreFile" ], "default": "coremanagement.CoreFile", "x-enum-as-string": true }, "AdminState": { "description": "Admin state prop to trigger file upload.\n* `None` - Admin configured None State.\n* `Upload` - Admin configured Upload State.", "type": "string", "enum": [ "None", "Upload" ], "default": "None", "x-omitempty": true }, "CoreFileDownloadUrl": { "description": "The Url to download the core file. It will be set only after successful completion of core file upload to storage service.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceType": { "description": "The device object type for the end point.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndpointIdentifier": { "description": "Endpoint device identifier. In IMM devices, it will be Fabric Interconnect hostname.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileName": { "description": "The name of core file from endpoint device.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileSize": { "description": "File size of core file in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NodeId": { "description": "Node id within cluster where core file is present.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "Product identification of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "Reason for upload failure, if any. In successful upload case, it will be empty.", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "Serial number of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of core file upload. Valid values are InventoryComplete (default), UploadInProgress, Completed, UploadFailed, FileDownloadUrlCreationFailed, CoreRemovedDownloadOnly.\n* `InventoryComplete` - Default status for all mos before file upload is requested.\n* `UploadInProgress` - File upload is in progress.\n* `UploadFailed` - File upload to storage service failed.\n* `Completed` - File upload to storage service completed successfully.\n* `FileDownloadUrlCreationFailed` - File upload to storage service completed successfully but download url creation failed.\n* `CoreRemovedDownloadOnly` - File upload to storage service completed successfully but file removed from endpoint device.", "type": "string", "enum": [ "InventoryComplete", "UploadInProgress", "UploadFailed", "Completed", "FileDownloadUrlCreationFailed", "CoreRemovedDownloadOnly" ], "default": "InventoryComplete", "readOnly": true, "x-omitempty": true }, "InventoryParent": { "$ref": "#/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": "#/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 } } } ] }, "coremanagement.CoreFile.List": { "title": "List of 'coremanagement.CoreFile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'coremanagement.CoreFile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'coremanagement.CoreFile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/coremanagement.CoreFile" }, "nullable": true } } } ] }, "coremanagement.Download.Response": { "description": "The response body of a HTTP GET request for the 'coremanagement.Download' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'coremanagement.Download' resources.", "x-one-of-name": "coremanagement.Download.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/coremanagement.Download.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "coremanagement.Download": { "title": "Coremanagement:Download", "description": "Download the core file. The response to this API will be the actual core file.", "x-allOf-name": "coremanagement.Download", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'coremanagement.Download', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "coremanagement.Download" ], "default": "coremanagement.Download", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "coremanagement.Download" ], "default": "coremanagement.Download", "x-enum-as-string": true }, "CoreFile": { "$ref": "#/components/schemas/coremanagement.CoreFile.Relationship", "description": "A reference to a coremanagementCoreFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "coremanagement.Download.List": { "title": "List of 'coremanagement.Download' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'coremanagement.Download' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'coremanagement.Download' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/coremanagement.Download" }, "nullable": true } } } ] }, "externalsite.Authorization.Response": { "description": "The response body of a HTTP GET request for the 'externalsite.Authorization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'externalsite.Authorization' resources.", "x-one-of-name": "externalsite.Authorization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/externalsite.Authorization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "externalsite.Authorization": { "title": "Externalsite:Authorization", "description": "An authentication request that will be used to get authorized from external repository like cisco.com in order to download the image. This MO creation is a one time configuration before calling firmware.Upgrade API. This MO has to be modified with updated details whenever the user has updated the credentials in external repository.", "x-allOf-name": "externalsite.Authorization", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'externalsite.Authorization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "externalsite.Authorization" ], "default": "externalsite.Authorization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "externalsite.Authorization" ], "default": "externalsite.Authorization", "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 }, "IsUserIdSet": { "description": "Indicates whether the value of the 'userId' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "The password of the given username to download the image from external repository like cisco.com.", "type": "string", "writeOnly": true, "x-omitempty": true }, "RepositoryType": { "description": "The repository type to which this authorization will be requested. Cisco is the only available repository today.\n* `cisco` - Cisco as an external site from where the resources like image will be downloaded.", "type": "string", "enum": [ "cisco" ], "default": "cisco", "x-omitempty": true }, "UserId": { "description": "The username that has permission to download the image from external repository like cisco.com.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "externalsite.Authorization.List": { "title": "List of 'externalsite.Authorization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'externalsite.Authorization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'externalsite.Authorization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/externalsite.Authorization" }, "nullable": true } } } ] }, "feedback.FeedbackData": { "title": "Feedback:Feedback Data", "description": "Feedback data collected from the user through the UI.", "x-allOf-name": "feedback.FeedbackData", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'feedback.FeedbackData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "feedback.FeedbackData" ], "default": "feedback.FeedbackData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "feedback.FeedbackData" ], "default": "feedback.FeedbackData", "x-enum-as-string": true }, "AccountName": { "description": "Account name of the feedback sender, copied for persistence in case of account removal.", "type": "string", "x-omitempty": true }, "AlternativeFollowUpEmails": { "type": "array", "items": { "description": "User's alternative email addresses for follow-up.", "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 }, "maxItems": 5, "nullable": true }, "Comment": { "description": "User feedback text (a bug or a suggestion).", "type": "string", "maxLength": 5000, "x-omitempty": true }, "Email": { "description": "User's email address details.", "type": "string", "x-omitempty": true }, "Evaluation": { "description": "Evaluation rating provided by the user to capture user sentiment regarding the issue.\n* `Excellent` - Option indicating user's excellent evaluation.\n* `Poor` - Option indicating user's poor evaluation.\n* `Fair` - Option indicating user's fair evaluation.\n* `Good` - Option indicating user's good evaluation.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "enum": [ "Excellent", "Poor", "Fair", "Good" ], "default": "Excellent", "x-omitempty": true }, "FollowUp": { "description": "User's consent for follow-up communication.", "type": "boolean", "x-omitempty": true }, "FullStoryUrl": { "description": "URL generated by FullStory linking to the UI session's recording.", "type": "string", "x-omitempty": true }, "ProductSatisfactionScale": { "description": "User's satisfaction with the product on a 0-10 scale.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 10, "x-omitempty": true }, "SurveyCompleted": { "description": "Survey completion status (True if completed, False otherwise).", "type": "boolean", "x-omitempty": true }, "TraceIds": { "description": "Collection of last traceId for replicating the user's last activity.", "nullable": true, "x-omitempty": true }, "Type": { "description": "Type of the feedback from user.\n* `Evaluation` - User's feedback classified as an evaluation.\n* `Bug` - User's feedback classified as a bug.\n* `Survey` - User's response to a survey.", "type": "string", "enum": [ "Evaluation", "Bug", "Survey" ], "default": "Evaluation", "x-omitempty": true } } } ] }, "feedback.FeedbackPost": { "title": "Feedback:Feedback Post", "description": "The FeedbackPost object serves as the initial entry point for user feedback within the system. This provides a mechanism for users to submit their comments and evaluations directly through the user interface. \n#### Purpose\nFeedback Post enables users to capture and submit first-hand feedback directly from the interface, ensuring that original input is accurately preserved and processed. It supports seamless UI integration, immediate submission, and reliable data retention for effective analysis and response\n#### Key Concepts\n- **User-Driven:** Facilitates direct interaction between users and the feedback system, ensuring that user voices are heard and considered.\n- **Shared Resource:** Functions as a shared organizational resource, accessible across various departments and privilege sets.", "x-allOf-name": "feedback.FeedbackPost", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'feedback.FeedbackPost', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "feedback.FeedbackPost" ], "default": "feedback.FeedbackPost", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "feedback.FeedbackPost" ], "default": "feedback.FeedbackPost", "x-enum-as-string": true }, "FeedbackData": { "description": "Feedback collected from the user and latest activity.", "$ref": "#/components/schemas/feedback.FeedbackData", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "filterexpr.AndFilterExpression": { "title": "Filterexpr:And Filter Expression", "description": "All child expressions must match.", "x-allOf-name": "filterexpr.AndFilterExpression", "allOf": [ { "$ref": "#/components/schemas/filterexpr.FilterExpression" }, { "type": "object", "description": "Definition of the list of properties defined in 'filterexpr.AndFilterExpression', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "filterexpr.AndFilterExpression" ], "default": "filterexpr.AndFilterExpression", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "filterexpr.AndFilterExpression" ], "default": "filterexpr.AndFilterExpression", "x-enum-as-string": true }, "Fields": { "type": "array", "items": { "description": "Conjuncts; must be a non-empty list.", "$ref": "#/components/schemas/filterexpr.FilterExpression", "x-omitempty": true }, "nullable": true } } } ] }, "filterexpr.FilterExpression": { "title": "Filterexpr:Filter Expression", "description": "Shared boolean filter tree. Inner nodes are conjunctions or disjunctions; leaves are predicate nodes.\nServices embed or reference this abstraction for domain-specific OData or query emitters.", "x-allOf-name": "filterexpr.FilterExpression", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "filterexpr.OrFilterExpression": { "title": "Filterexpr:Or Filter Expression", "description": "At least one child expression must match.", "x-allOf-name": "filterexpr.OrFilterExpression", "allOf": [ { "$ref": "#/components/schemas/filterexpr.FilterExpression" }, { "type": "object", "description": "Definition of the list of properties defined in 'filterexpr.OrFilterExpression', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "filterexpr.OrFilterExpression" ], "default": "filterexpr.OrFilterExpression", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "filterexpr.OrFilterExpression" ], "default": "filterexpr.OrFilterExpression", "x-enum-as-string": true }, "Fields": { "type": "array", "items": { "description": "Disjuncts; must be a non-empty list.", "$ref": "#/components/schemas/filterexpr.FilterExpression", "x-omitempty": true }, "nullable": true } } } ] }, "filterexpr.PredicateFilterExpression": { "title": "Filterexpr:Predicate Filter Expression", "description": "A single predicate (property, operator, values) with optional managed-object reference for invalidation\nor display resolution.", "x-allOf-name": "filterexpr.PredicateFilterExpression", "allOf": [ { "$ref": "#/components/schemas/filterexpr.FilterExpression" }, { "type": "object", "description": "Definition of the list of properties defined in 'filterexpr.PredicateFilterExpression', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "filterexpr.PredicateFilterExpression" ], "default": "filterexpr.PredicateFilterExpression", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "filterexpr.PredicateFilterExpression" ], "default": "filterexpr.PredicateFilterExpression", "x-enum-as-string": true }, "Operator": { "description": "Comparison or set operator (for example eq, ne, contains, in); semantics are defined by the consuming service.", "type": "string", "x-omitempty": true }, "Property": { "description": "Property path for OData or the target query DSL (e.g. dotted paths and array keys when supported).", "type": "string", "x-omitempty": true }, "PropertyReference": { "type": "array", "items": { "description": "Optional reference to a managed object this predicate is tied to; enables reverse lookup\nand refresh when that MO or denormalized filter values change.", "$ref": "#/components/schemas/mo.MoRef", "x-omitempty": true }, "nullable": true }, "Value": { "type": "array", "items": { "description": "Values to match; semantics depend on operator and domain.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "hci.AhvGuestTools": { "title": "Hci:Ahv Guest Tools", "description": "The details of the Nutanix Guest Tools.", "x-allOf-name": "hci.AhvGuestTools", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.AhvGuestTools', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.AhvGuestTools" ], "default": "hci.AhvGuestTools", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.AhvGuestTools" ], "default": "hci.AhvGuestTools", "x-enum-as-string": true }, "AvailableVersion": { "description": "The available version of the Nutanix Guest Tools.", "type": "string", "readOnly": true, "x-omitempty": true }, "Capabilities": { "type": "array", "items": { "description": "The capabilities of the Nutanix Guest Tools.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "GuestOsVersion": { "description": "The guest OS version of the Nutanix Guest Tools.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsEnabled": { "description": "Indicates if the Nutanix Guest Tools is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsInstalled": { "description": "Indicates if the Nutanix Guest Tools is installed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsIsoInserted": { "description": "Indicates if the Nutanix Guest Tools ISO is inserted.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsReachable": { "description": "Indicates if the Nutanix Guest Tools is reachable.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsVmMobilityDriverInstalled": { "description": "Indicates if the Nutanix Guest Tools VM mobility driver is installed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsVssSnapshotCapable": { "description": "Indicates if the Nutanix Guest Tools is VSS snapshot capable.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the Nutanix Guest Tools.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.AhvVm.Response": { "description": "The response body of a HTTP GET request for the 'hci.AhvVm' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.AhvVm' resources.", "x-one-of-name": "hci.AhvVm.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.AhvVm.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.AhvVm.Relationship": { "description": "A relationship to the 'hci.AhvVm' resource, or the expanded 'hci.AhvVm' resource, or the 'null' value.", "x-one-of-name": "hci.AhvVm.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.AhvVm" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.AhvVm": { "title": "Hci:Ahv Vm", "description": "An AHV VM reported by Prism Central.", "x-allOf-name": "hci.AhvVm", "allOf": [ { "$ref": "#/components/schemas/hci.BaseVm" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.AhvVm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.AhvVm" ], "default": "hci.AhvVm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.AhvVm" ], "default": "hci.AhvVm", "x-enum-as-string": true }, "BiosUuid": { "description": "The BIOS UUID of the VM, similar to physical server's serial number.", "type": "string", "readOnly": true, "x-omitempty": true }, "CreationTime": { "description": "The time the VM was created.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "EnabledCpuFeatures": { "type": "array", "items": { "description": "The list of additional CPU features to be enabled.\nHardwareVirtualization: Indicates whether hardware assisted \nvirtualization should be enabled for the Guest OS or not. \nOnce enabled, the Guest OS can deploy a nested hypervisor.\nCurrently only HARDWARE_VIRTUALIZATION is listed.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "GenerationUuid": { "description": "The generation UUID of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "GuestTools": { "description": "The detail of the guest tools installed on the VM.", "$ref": "#/components/schemas/hci.AhvGuestTools", "readOnly": true, "x-omitempty": true }, "HardwareClockTimezone": { "description": "VM hardware clock timezone in IANA TZDB format (America/Los_Angeles). \nDefault: UTC.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsAgentVm": { "description": "Indicates whether the VM is an agent VM or not. When their host\nenters maintenance mode, once the normal VMs are evacuated, the \nagent VMs are powered off. When the host is restored, agent VMs \nare powered on before the normal VMs are restored. In other words, \nagent VMs cannot be HA-protected or live migrated.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsBrandingEnabled": { "description": "Indicates whether to remove AHV branding from VM firmware tables or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsCpuHotplugEnabled": { "description": "The CPU hotplug status of the VM. It indicates whether the CPU \nhotplug feature should be enabled for the VM or not. If enabled, \nthe VM can add or remove vCPUs while the VM is running.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsCpuPassthroughEnabled": { "description": "The CPU passthrough status of the VM. It Indicates whether\nto passthrough the host CPU features to the guest or not. \nEnabling this will make VM incapable of live migration.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsCrossClusterMigrationInProgress": { "description": "Indicates whether the VM is in the process of cross cluster migration or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsGpuConsoleEnabled": { "description": "The GPU console status of the VM. It indicates whether the GPU \nconsole should be enabled for the VM or not. If enabled, the VM \nwill have access to the GPU console.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsLiveMigrateCapable": { "description": "Indicates whether the VM is live migrate capable or not. \nIf the VM is not live migrate capable, it cannot be live migrated.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsMemoryOvercommitEnabled": { "description": "The memory overcommit status of the VM. It indicates whether\nthe memory overcommit feature should be enabled for the VM or not.\nIf enabled, parts of the VM memory may reside outside of the \nhypervisor physical memory. Once enabled, it should be expected \nthat the VM may suffer performance degradation.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsScsiControllerEnabled": { "description": "The SCSI controller status of the VM. It indicates whether the \nSCSI controller should be enabled for the VM or not. If enabled, \nthe VM will have access to the SCSI controller.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsVcpuHardPinningEnabled": { "description": "The hard pinning status of the vCPU. It indicates whether the vCPUs \nshould be hard pinned to specific pCPUs or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsVgaConsoleEnabled": { "description": "Indicates whether to enable VGA console for the VM or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsVtpmEnabled": { "description": "Indicates whether the VM has a virtual TPM enabled or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MachineType": { "description": "The machine type of the VM. Possible values are PC, PSERIES, Q35.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumNumaNodes": { "description": "Number of NUMA nodes. 0 means NUMA is disabled.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "NumSockets": { "description": "The number of sockets of the VM.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "NumThreadsPerCore": { "description": "The number of threads per core of the VM.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "ProtectionType": { "description": "The type of protection applied on a VM. \nPossible values are UNPROTECTED, PD_PROTECTED, and RULE_PROTECTED.\nPD_PROTECTED indicates a VM is protected using the Prism Element. \nRULE_PROTECTED indicates a VM protection using the Prism Central.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceUuid": { "description": "The source UUID of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpdateTime": { "description": "The time the VM was last updated.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "VtpmModuleVersion": { "description": "The version of the vTPM module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Disks": { "description": "An array of relationships to hciAhvVmDisk resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.AhvVmDisk.Relationship" }, "nullable": true, "readOnly": true }, "Gpus": { "description": "An array of relationships to hciAhvVmGpu resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.AhvVmGpu.Relationship" }, "nullable": true, "readOnly": true }, "Nics": { "description": "An array of relationships to hciAhvVmNic resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.AhvVmNic.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.AhvVm.List": { "title": "List of 'hci.AhvVm' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.AhvVm' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.AhvVm' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.AhvVm" }, "nullable": true } } } ] }, "hci.AhvVmDisk.Response": { "description": "The response body of a HTTP GET request for the 'hci.AhvVmDisk' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.AhvVmDisk' resources.", "x-one-of-name": "hci.AhvVmDisk.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.AhvVmDisk.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.AhvVmDisk.Relationship": { "description": "A relationship to the 'hci.AhvVmDisk' resource, or the expanded 'hci.AhvVmDisk' resource, or the 'null' value.", "x-one-of-name": "hci.AhvVmDisk.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.AhvVmDisk" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.AhvVmDisk": { "title": "Hci:Ahv Vm Disk", "description": "A disk associated with an AHV VM.", "x-allOf-name": "hci.AhvVmDisk", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.AhvVmDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.AhvVmDisk" ], "default": "hci.AhvVmDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.AhvVmDisk" ], "default": "hci.AhvVmDisk", "x-enum-as-string": true }, "AdsfVolumeGroupExtId": { "description": "The extId of the volume group which backs this disk for block access. ADSF (Acropolis Distributed Storage \nFabric) is the storage layer of the Nutanix platform that provides a distributed \nstorage system. It abstracts and pools the storage resources across the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "BusType": { "description": "The bus type of the disk. Possible values are 'IDE', 'PCI', 'SCSI', 'SATA', 'SPAPR'.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskExtId": { "description": "The unique identifier of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskSizeBytes": { "description": "The size of the disk in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Index": { "description": "The index of the disk, similar to a slot number on physical machine.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "IsExternalStorage": { "description": "Derived property based on if storage container used external storage.\nNote: this value is independent of existence of volumeExtId. When a volumeExtId is empty \n(when the Pure Inventory is not available), this value can be true because storage container \nindicates external storage is used. If volumeExtId is true, it does indicate the isExternalStorage \nshould be true.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsFlashModeEnabled": { "description": "Indicates whether the virtual disk is pinned to the hot tier or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsMigrationInProgress": { "description": "Indicates if the disk is being migrated.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StorageContainerExtId": { "description": "The extId of the storage container which backs this disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "VmExtId": { "description": "The unique identifier of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "VolumeExtId": { "description": "The volume id this VM disk owns. Either from 'resource.Id' of the Pure Volume 'owner_disk_id' tag \n(see 9.5.1.1.2 for detail) or from V4 VM API after Iris.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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/hci.StorageContainer.Relationship", "description": "A reference to a hciStorageContainer resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Vm": { "$ref": "#/components/schemas/hci.AhvVm.Relationship", "description": "A reference to a hciAhvVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Volume": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/storage.BaseVolume.Relationship", "description": "A reference to a storageBaseVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "hci.AhvVmDisk.List": { "title": "List of 'hci.AhvVmDisk' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.AhvVmDisk' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.AhvVmDisk' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.AhvVmDisk" }, "nullable": true } } } ] }, "hci.AhvVmGpu.Response": { "description": "The response body of a HTTP GET request for the 'hci.AhvVmGpu' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.AhvVmGpu' resources.", "x-one-of-name": "hci.AhvVmGpu.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.AhvVmGpu.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.AhvVmGpu.Relationship": { "description": "A relationship to the 'hci.AhvVmGpu' resource, or the expanded 'hci.AhvVmGpu' resource, or the 'null' value.", "x-one-of-name": "hci.AhvVmGpu.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.AhvVmGpu" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.AhvVmGpu": { "title": "Hci:Ahv Vm Gpu", "description": "A GPU associated with an AHV VM.", "x-allOf-name": "hci.AhvVmGpu", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.AhvVmGpu', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.AhvVmGpu" ], "default": "hci.AhvVmGpu", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.AhvVmGpu" ], "default": "hci.AhvVmGpu", "x-enum-as-string": true }, "DeviceId": { "description": "The device id of the GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Fraction": { "description": "The fraction of a physical GPU's resources that are allocated to a virtual GPU, e.g. 8 indicate 1/8 of a GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FrameBufferSizeBytes": { "description": "The frame buffer size of the GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "GpuExtId": { "description": "The unique identifier of the GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "GuestDriverVersion": { "description": "Last determined guest driver version.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mode": { "description": "The mode of the GPU such as UNUSED, USED_FOR_PASSTHROUGH, USED_FOR_VIRTUAL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the GPU allocation such as \"NVIDIA_A16-1B\".", "type": "string", "readOnly": true, "x-omitempty": true }, "NumVirtualDisplayHeads": { "description": "The number of virtual display heads of the GPU.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "PciAddress": { "description": "The PCI address of the GPU.", "$ref": "#/components/schemas/hci.Sbdf", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "The vendor name of the GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "VmExtId": { "description": "The unique identifier of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 }, "Vm": { "$ref": "#/components/schemas/hci.AhvVm.Relationship", "description": "A reference to a hciAhvVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "hci.AhvVmGpu.List": { "title": "List of 'hci.AhvVmGpu' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.AhvVmGpu' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.AhvVmGpu' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.AhvVmGpu" }, "nullable": true } } } ] }, "hci.AhvVmNic.Response": { "description": "The response body of a HTTP GET request for the 'hci.AhvVmNic' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.AhvVmNic' resources.", "x-one-of-name": "hci.AhvVmNic.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.AhvVmNic.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.AhvVmNic.Relationship": { "description": "A relationship to the 'hci.AhvVmNic' resource, or the expanded 'hci.AhvVmNic' resource, or the 'null' value.", "x-one-of-name": "hci.AhvVmNic.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.AhvVmNic" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.AhvVmNic": { "title": "Hci:Ahv Vm Nic", "description": "A NIC associated with an AHV VM.", "x-allOf-name": "hci.AhvVmNic", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.AhvVmNic', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.AhvVmNic" ], "default": "hci.AhvVmNic", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.AhvVmNic" ], "default": "hci.AhvVmNic", "x-enum-as-string": true }, "IpAddresses": { "type": "array", "items": { "description": "The IP addresses of the NIC.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsConnected": { "description": "Indicates if the NIC is connected.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LearnedIpAddresses": { "type": "array", "items": { "description": "The IP addresses as found on the guest VM for the NIC.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MacAddress": { "description": "The MAC address of the NIC.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The model name of emulated NIC.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetworkFunctionNicType": { "description": "The type of this network function NIC.", "type": "string", "readOnly": true, "x-omitempty": true }, "NicExtId": { "description": "The unique identifier of the NIC.", "type": "string", "readOnly": true, "x-omitempty": true }, "NicType": { "description": "The type of the NIC. Possible values are 'NORMAL_NIC', 'DIRECT_NIC', 'NETWORK_FUNCTION_NIC', 'SPAN_DESTINATION_NIC'.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumQueues": { "description": "The number of Tx/Rx queue pairs for this NIC.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "ShouldAllowUnknownMacs": { "description": "Indicates whether an unknown unicast traffic is forwarded to this NIC or not, only for the NICs on the overlay subnets.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "TrunkedVlans": { "type": "array", "items": { "description": "List of networks to trunk if VLAN mode is marked as TRUNKED. If empty and VLAN mode is set to TRUNKED, all the VLANs are trunked.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "nullable": true }, "VlanId": { "description": "VLAN ID of subnet for this NIC.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "VlanMode": { "description": "By default, all the virtual NICs are created in ACCESS mode, which permits only one VLAN per virtual network. TRUNKED mode allows multiple VLANs on a single VM NIC for network-aware user VMs.", "type": "string", "readOnly": true, "x-omitempty": true }, "VmExtId": { "description": "The unique identifier of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 }, "Vm": { "$ref": "#/components/schemas/hci.AhvVm.Relationship", "description": "A reference to a hciAhvVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "hci.AhvVmNic.List": { "title": "List of 'hci.AhvVmNic' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.AhvVmNic' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.AhvVmNic' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.AhvVmNic" }, "nullable": true } } } ] }, "hci.Alarm.Response": { "description": "The response body of a HTTP GET request for the 'hci.Alarm' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.Alarm' resources.", "x-one-of-name": "hci.Alarm.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.Alarm.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.Alarm": { "title": "Hci:Alarm", "description": "An alert from an HCI cluster reported from the Prism Central serviceability/Alerts API.", "x-allOf-name": "hci.Alarm", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Alarm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Alarm" ], "default": "hci.Alarm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.Alarm" ], "default": "hci.Alarm", "x-enum-as-string": true }, "AlarmExtId": { "description": "The unique identifier for the alarm on the endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "AlertType": { "description": "The code for the reported alarm.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterExtId": { "description": "The unique identifer for the cluster associated with the source entity on the endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsResolved": { "description": "The status of the alarm. If an alarm is resolved, this value is set as true on the endpoint.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Message": { "description": "The description from the endpoint explaining the cause of the alarm.", "type": "string", "readOnly": true, "x-omitempty": true }, "OriginAcknowledgeTime": { "description": "The time the alarm was acknowledged on the endpoint.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "OriginCreationTime": { "description": "The time the alarm was created on the endpoint.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "OriginIsAcknowledged": { "description": "The acknowledgement status of the alert on the endpoint.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Parameters": { "type": "array", "items": { "description": "The parameters of the alarm from the endpoint. The properties are used to populate the values in the title and message fields of the alarm.", "$ref": "#/components/schemas/hci.AlarmParameter", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ResolvedTime": { "description": "The time the alarm was resolved on the endpoint.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "The severity of the alarm. Valid values are Critical, Warning, Info.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "readOnly": true, "x-omitempty": true }, "SourceEntityExtId": { "description": "The unique identifer for the entity on the endpoint for which the alarm was raised.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceEntityName": { "description": "The name of the entity on the endpoint for which the alarm was raised.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceEntityType": { "description": "The object type for the entity corresponding to the objects inventoried.", "type": "string", "readOnly": true, "x-omitempty": true }, "Title": { "description": "The title of the reported alarm.", "type": "string", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.Alarm.List": { "title": "List of 'hci.Alarm' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.Alarm' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.Alarm' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Alarm" }, "nullable": true } } } ] }, "hci.AlarmParameter": { "title": "Hci:Alarm Parameter", "description": "The key value pair of parameters from the endpoint alarm object to populate the fields in the title and message properties.", "x-allOf-name": "hci.AlarmParameter", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.AlarmParameter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.AlarmParameter" ], "default": "hci.AlarmParameter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.AlarmParameter" ], "default": "hci.AlarmParameter", "x-enum-as-string": true }, "Name": { "description": "The name of the alarm parameter from the endpoint object.", "type": "string", "readOnly": true, "x-omitempty": true }, "Value": { "description": "The value of the alarm parameter from the endpoint object.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.AlarmSummary": { "title": "Hci:Alarm Summary", "description": "The summary of alarm counts based on alarm severity.", "x-allOf-name": "hci.AlarmSummary", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.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": [ "hci.AlarmSummary" ], "default": "hci.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": [ "hci.AlarmSummary" ], "default": "hci.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": "The health of the managed endpoint. The health is computed from the highest-severity alarm raised on the endpoint.\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 }, "Warning": { "description": "The count of alarms that have severity type Warning.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "hci.ApiLimit": { "title": "Hci:Api Limit", "description": "The limit info about an Nutanix API. Once the limit is reached, the API will return incomplete results.", "x-allOf-name": "hci.ApiLimit", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ApiLimit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ApiLimit" ], "default": "hci.ApiLimit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ApiLimit" ], "default": "hci.ApiLimit", "x-enum-as-string": true }, "ActualSize": { "description": "The actual number of records returned by the API.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "ApiName": { "description": "The name of the Nutanix API that has reach the limit.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsLimitReached": { "description": "Indicates if the limit is reached.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Limit": { "description": "The number of records the API is allowed to return.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true } } } ] }, "hci.BackplaneNetworkParams": { "title": "Hci:Backplane Network Params", "description": "The backplane network parameters.", "x-allOf-name": "hci.BackplaneNetworkParams", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.BackplaneNetworkParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.BackplaneNetworkParams" ], "default": "hci.BackplaneNetworkParams", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.BackplaneNetworkParams" ], "default": "hci.BackplaneNetworkParams", "x-enum-as-string": true }, "IsSegmentationEnabled": { "description": "Is segmentation enabled on the backplane.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Netmask": { "description": "The netmask of the network of this backplane.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "Subnet": { "description": "The subnet of the network of this backplane.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "VlanTag": { "description": "The vlan tag of this backplane.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true } } } ] }, "hci.BaseVm.Relationship": { "description": "A relationship to the 'hci.BaseVm' resource, or the expanded 'hci.BaseVm' resource, or the 'null' value.", "x-one-of-name": "hci.BaseVm.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.BaseVm" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.BaseVm": { "title": "Hci:Base Vm", "description": "A base VM reported by Prism Central.", "x-allOf-name": "hci.BaseVm", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.BaseVm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "hci.AhvVm", "hci.EsxiVm" ], "x-enum-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": [ "hci.AhvVm", "hci.EsxiVm" ], "x-enum-as-string": true }, "ClusterExtId": { "description": "The unique identifier of the cluster which owns this VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "The description of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "GuestOsName": { "description": "The guest OS name of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "HypervisorType": { "description": "The hypervisor type of the given VM. It could be AHV, ESX etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "MemorySizeBytes": { "description": "The memory size in bytes of the VM.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the VM reported by the Prism Central.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeExtId": { "description": "The unique identifier of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumCoresPerSocket": { "description": "The number of cores per socket of the VM.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "NumCpuCores": { "description": "The number of CPU cores of the VM.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PowerState": { "description": "The power state of the VM. The possible values are ON, OFF, SUSPENDED (ESXi), PAUSED (AHV), UNDETERMINED.\n* `UNDETERMINED` - The VM power state is currently unknown.\n* `OFF` - The VM's power state is powered-off.\n* `ON` - The VM's power state is powered-on.\n* `PAUSED` - The VM's power state is paused, applicable only to AHV VM.\n* `SUSPENDED` - The VM's power state is suspended, applicable only to ESXi VM.", "type": "string", "enum": [ "UNDETERMINED", "OFF", "ON", "PAUSED", "SUSPENDED" ], "default": "UNDETERMINED", "readOnly": true, "x-omitempty": true }, "VmExtId": { "description": "The unique identifier of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Node": { "$ref": "#/components/schemas/hci.Node.Relationship", "description": "A reference to a hciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "hci.CapacityViolation": { "title": "Hci:Capacity Violation", "description": "The violation of a capacity.", "x-allOf-name": "hci.CapacityViolation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.CapacityViolation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.CapacityViolation" ], "default": "hci.CapacityViolation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.CapacityViolation" ], "default": "hci.CapacityViolation", "x-enum-as-string": true }, "Category": { "description": "The category of the license that has violation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Meter": { "description": "The meter of the license that has violation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Shortfall": { "description": "This indicates the insufficient quantity of a license. License of\ngiven quantity should be applied on the cluster for it to function properly.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the license that has violation.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.Cluster.Response": { "description": "The response body of a HTTP GET request for the 'hci.Cluster' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.Cluster' resources.", "x-one-of-name": "hci.Cluster.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.Cluster.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.Cluster.Relationship": { "description": "A relationship to the 'hci.Cluster' resource, or the expanded 'hci.Cluster' resource, or the 'null' value.", "x-one-of-name": "hci.Cluster.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.Cluster" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.Cluster": { "title": "Hci:Cluster", "description": "The Cluster object represents a cluster, as reported by Nutanix Prism Central. This provides a structured representation of clusters, including their configuration and operational status.\n#### Purpose \nThe Cluster object serves as a central point of information for understanding the characteristics of Nutanix clusters. It enables administrators to monitor cluster status and configuration.\n#### Key Concepts\n- **Configuration Details:** Provides insights into cluster attributes, including software and hardware configurations, license. \n- **Performance Monitoring:** Tracks key performance indicators such as VM count, upgrade status, and resource utilization.", "x-allOf-name": "hci.Cluster", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Cluster', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Cluster" ], "default": "hci.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.", "enum": [ "hci.Cluster" ], "default": "hci.Cluster", "x-enum-as-string": true }, "AlarmSummary": { "description": "The summary of active alarm counts based on the severity types (Critical, Warning or Info).", "$ref": "#/components/schemas/hci.AlarmSummary", "readOnly": true, "x-omitempty": true }, "Backplane": { "description": "The backplane network parameters.", "$ref": "#/components/schemas/hci.BackplaneNetworkParams", "readOnly": true, "x-omitempty": true }, "BuildInfoBuildType": { "description": "The software build type, such as \"release\" or \"debug\" build.", "type": "string", "readOnly": true, "x-omitempty": true }, "BuildInfoCommitId": { "description": "The software commit id for this build image.", "type": "string", "readOnly": true, "x-omitempty": true }, "BuildInfoFullVersion": { "description": "The longer form of software version. It usually includes the commit id.", "type": "string", "readOnly": true, "x-omitempty": true }, "BuildInfoShortCommitId": { "description": "The short version of the software commit id for this build image.", "type": "string", "readOnly": true, "x-omitempty": true }, "BuildInfoVersion": { "description": "The software version from the build.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterArch": { "description": "The CPU architecture of the cluster server such as x86_64 and PPC64LE.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterExtId": { "description": "The unique identifier of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterFunction": { "type": "array", "items": { "description": "The function of the cluster, such as 'PRISM_CENTRAL' to indicate a Prism Central cluster,\nis part of the payload for the cluster creation operation only.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ClusterSoftwareMap": { "type": "array", "items": { "description": "The software map of the cluster.", "$ref": "#/components/schemas/hci.SoftwareType", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ClusterType": { "description": "The type of the cluster. Possible values:\n- HYPER_CONVERGED: Traditional HCI cluster using local storage.\n- COMPUTE: Cluster using external storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "ContainerName": { "description": "The name of the default container created as part of cluster creation.", "type": "string", "readOnly": true, "x-omitempty": true }, "CpuCapacityHz": { "description": "The CPU capacity in Hz of the cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CpuUsageHz": { "description": "The CPU usage in Hz of the cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EncryptionInTransitStatus": { "description": "Indicate if encryption-in-transit is enabled or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "EncryptionScope": { "type": "array", "items": { "description": "The encryption scope of the cluster, e.g. in CONTAINER or CLUSTER level.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExternalAddress": { "description": "The external address of the cluster.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "ExternalDataServiceIp": { "description": "The external data service IP address of the cluster.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "ExternalSubnet": { "description": "The external subnet of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "FaultToleranceState": { "description": "The fault tolerance state of the cluster.", "$ref": "#/components/schemas/hci.FaultToleranceState", "readOnly": true, "x-omitempty": true }, "HypervisorTypes": { "type": "array", "items": { "description": "The collection of hypervisor types among the nodes in the clusters includes the known\nvalues: AHV, ESX, HYPERV, XEN, and NATIVEHOST.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Incarnationid": { "description": "Cluster incarnation Id, part of payload for cluster update operation only.", "type": "string", "readOnly": true, "x-omitempty": true }, "InefficientVmCount": { "description": "The number of inefficient VMs in this cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "InternalSubnet": { "description": "The internal subnet of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsLts": { "description": "The LTS status indicates whether the release is categorized as Long-term or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "KeyManagementServerType": { "description": "The key management server type of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManagementServer": { "description": "The management server of the cluster.", "$ref": "#/components/schemas/hci.ManagementServer", "readOnly": true, "x-omitempty": true }, "MasqueradingIp": { "description": "The masquerading IP of the cluster.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "MasqueradingPort": { "description": "The masquerading port of the cluster.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "MemoryCapacityBytes": { "description": "The memory capacity in bytes of the cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MemoryUsageBytes": { "description": "The memory usage in bytes of the cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the reported cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "NameServerIpList": { "type": "array", "items": { "description": "The name server IP list of the cluster.", "$ref": "#/components/schemas/hci.IpAddressOrFqdn", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NtpServerIpList": { "type": "array", "items": { "description": "The NTP server IP list of the cluster.", "$ref": "#/components/schemas/hci.IpAddressOrFqdn", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NumberOfNodes": { "description": "The number of nodes in the cluster.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "OperationMode": { "description": "The operation mode of the cluster such as NORMAL, READ_ONLY, STAND_ALONE, SWITCH_TO_TWO_NODE, OVERRIDE.", "type": "string", "readOnly": true, "x-omitempty": true }, "PasswordRemoteLoginEnabled": { "description": "Indicates whether the password ssh into the cluster is enabled or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "PcExtId": { "description": "The unique identifier of the domain manager (Prism Central) instance which manages this cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "PulseStatus": { "description": "The pulse status of the cluster.", "$ref": "#/components/schemas/hci.PulseStatus", "readOnly": true, "x-omitempty": true }, "RedundancyFactor": { "description": "The redundancy factor of the cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RemoteSupport": { "description": "The remote support status of the cluster.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StorageCapacityBytes": { "description": "The storage capacity in bytes of the cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageUsageBytes": { "description": "The storage usage in bytes of the cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Timezone": { "description": "The timezone of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpgradeStatus": { "description": "The upgrade status of a cluster includes the following known values PENDING, DOWNLOADING, QUEUED, PREUPGRADE, UPGRADING, SUCCEEDED,\nFAILED, CANCELLED, and SCHEDULED.The upgrade status of a cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "VmCount": { "description": "The number of VMs running on this cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ClusterOperation": { "$ref": "#/components/schemas/hci.ClusterOperation.Relationship", "description": "A reference to a hciClusterOperation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Compliance": { "$ref": "#/components/schemas/hci.Compliance.Relationship", "description": "A reference to a hciCompliance resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DomainManager": { "$ref": "#/components/schemas/hci.DomainManager.Relationship", "description": "A reference to a hciDomainManager resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Entitlement": { "$ref": "#/components/schemas/hci.Entitlement.Relationship", "description": "A reference to a hciEntitlement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Nodes": { "description": "An array of relationships to hciNode resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Node.Relationship" }, "nullable": true, "readOnly": true }, "PhysicalGpus": { "description": "An array of relationships to hciPhysicalGpu resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.PhysicalGpu.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 }, "StorageContainers": { "description": "An array of relationships to hciStorageContainer resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.StorageContainer.Relationship" }, "nullable": true, "readOnly": true }, "Violation": { "$ref": "#/components/schemas/hci.Violation.Relationship", "description": "A reference to a hciViolation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "VirtualGpus": { "description": "An array of relationships to hciVirtualGpu resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.VirtualGpu.Relationship" }, "nullable": true, "readOnly": true }, "Vms": { "description": "An array of relationships to hciBaseVm resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.BaseVm.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "hci.Cluster.List": { "title": "List of 'hci.Cluster' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.Cluster' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.Cluster' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Cluster" }, "nullable": true } } } ] }, "hci.ClusterOpInfo": { "title": "Hci:Cluster Op Info", "description": "Status tracking information for a specific cluster operation type (e.g., NCC check).", "x-allOf-name": "hci.ClusterOpInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ClusterOpInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ClusterOpInfo" ], "default": "hci.ClusterOpInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ClusterOpInfo" ], "default": "hci.ClusterOpInfo", "x-enum-as-string": true }, "LastRunTime": { "description": "The timestamp when the operation was last started.\nSet when transitioning to \"InProgress\" or \"Scheduled\" states.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The current state of the operation. Possible values:\n- NotStarted: Operation never executed.\n- Scheduled: Workflow trigger requested (async mode), awaiting callback.\n- InProgress: Workflow is executing.\n- Completed: Operation finished successfully.\n- Failed: Operation failed or timed out.", "type": "string", "default": "NotStarted", "readOnly": true, "x-omitempty": true }, "WorkflowInfoMoid": { "description": "The MoID of the workflow.WorkflowInfo object tracking this operation's execution.\nEmpty for operations in \"Scheduled\" or \"NotStarted\" states.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowType": { "description": "The workflow type identifier for this operation. Examples: \"hci.NutanixClusterCheck\", \"hci.ClusterUpgrade\".", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.ClusterOperation.Response": { "description": "The response body of a HTTP GET request for the 'hci.ClusterOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.ClusterOperation' resources.", "x-one-of-name": "hci.ClusterOperation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.ClusterOperation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.ClusterOperation.Relationship": { "description": "A relationship to the 'hci.ClusterOperation' resource, or the expanded 'hci.ClusterOperation' resource, or the 'null' value.", "x-one-of-name": "hci.ClusterOperation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.ClusterOperation" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.ClusterOperation": { "title": "Hci:Cluster Operation", "description": "The ClusterOperation object is an inventory managed object that allows users to trigger and track cluster-level operations such as NCC checks, configuration changes, and diagnostics. It acts as a coordination point for workflows that operate on Nutanix clusters.\n#### Purpose\nThe ClusterOperation object enables users to initiate operations on a cluster and monitor their progress. Each operation type (e.g., NCC check) is tracked independently with its own status, results, and workflow information.\n#### Key Concepts\n- **Action-based Trigger**: Operations are initiated by setting the appropriate action field (e.g., nutanixClusterCheck.action = \"Run\"). \n- **Execution Modes**: Supports both synchronous (wait for workflow trigger) and asynchronous (immediate return) execution via operation's executionMode property.\n- **Status Tracking**: Each operation type maintains its own status in the clusterOpInfos array, preventing status overwrites when multiple operations run concurrently.\n- **Workflow Integration**: Integrates with Intersight workflow engine for operation execution with callbacks for status updates.", "x-allOf-name": "hci.ClusterOperation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ClusterOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ClusterOperation" ], "default": "hci.ClusterOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ClusterOperation" ], "default": "hci.ClusterOperation", "x-enum-as-string": true }, "ClusterExtId": { "description": "The unique identifier of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterOpInfos": { "type": "array", "items": { "description": "Array of operation status entries, one per operation type.", "$ref": "#/components/schemas/hci.ClusterOpInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "The display name of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "NutanixClusterCheck": { "description": "Configuration for Nutanix Cluster Check (NCC) operation.", "$ref": "#/components/schemas/hci.NutanixClusterCheck", "x-omitempty": true }, "PendingWorkflowTriggers": { "type": "array", "items": { "description": "List of workflow triggers awaiting callback response (async mode only).", "$ref": "#/components/schemas/hci.PendingWorkflowTrigger", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.ClusterOperation.List": { "title": "List of 'hci.ClusterOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.ClusterOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.ClusterOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.ClusterOperation" }, "nullable": true } } } ] }, "hci.Compliance.Response": { "description": "The response body of a HTTP GET request for the 'hci.Compliance' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.Compliance' resources.", "x-one-of-name": "hci.Compliance.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.Compliance.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.Compliance.Relationship": { "description": "A relationship to the 'hci.Compliance' resource, or the expanded 'hci.Compliance' resource, or the 'null' value.", "x-one-of-name": "hci.Compliance.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.Compliance" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.Compliance": { "title": "Hci:Compliance", "description": "The Compliance object offers a comprehensive view of licensing compliance within clusters, as reported by Nutanix Prism Central.\n#### Purpose \nThe Compliance object enables efficient monitoring of the cluster\u2019s license compliance and any software usage violations. It aids in ensuring adherence to software agreements and operational guidelines. \n#### Key Concepts \n- **Compliance Tracking:** Provides insights into compliance status and usage violation details.", "x-allOf-name": "hci.Compliance", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Compliance', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Compliance" ], "default": "hci.Compliance", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.Compliance" ], "default": "hci.Compliance", "x-enum-as-string": true }, "ClusterExtId": { "description": "The identifier of a license, usually in LIC-xxxx format.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComplianceState": { "description": "The compliance state of the cluster. The compliance state is determined based on the\nnonComplianceCount and the license enforcement policy.\n* `NotEnforced` - The license compliance state for a Nutanix cluster is neither in=compliance nor not in-compliance.Typically, when a license is not installed on a cluster, or the license enformancement is explicitlyturned off, the cluster is in this state.\n* `InCompliance` - The license compliance state for a Nutanix cluster is in compliance.\n* `NotInCompliance` - The license compliance state for a Nutanix cluster is not in compliance.", "type": "string", "enum": [ "NotEnforced", "InCompliance", "NotInCompliance" ], "default": "NotEnforced", "readOnly": true, "x-omitempty": true }, "NonComplianceCount": { "description": "Total number of services that are not in-compliance. A count of 0 does not necessarily\nmean in compliance. Depending on 'complianceState', the cluster could be either be\nin compliance or the license check is not enforced.\nA synthesized property for the services property for ease of querying.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "Services": { "type": "array", "items": { "description": "The collection of licensed services status associated with cluster.", "$ref": "#/components/schemas/hci.LicensedService", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Type": { "description": "The type of the cluster which could be NUTANIX, VMWARE, or NON_NUTANIX.", "type": "string", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.Compliance.List": { "title": "List of 'hci.Compliance' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.Compliance' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.Compliance' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Compliance" }, "nullable": true } } } ] }, "hci.ConfigurableParamValue": { "title": "Hci:Configurable Param Value", "description": "Value for a configurable parameter.", "x-allOf-name": "hci.ConfigurableParamValue", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ConfigurableParamValue', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ConfigurableParamValue" ], "default": "hci.ConfigurableParamValue", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ConfigurableParamValue" ], "default": "hci.ConfigurableParamValue", "x-enum-as-string": true }, "CurrentValue": { "description": "Current value of the parameter.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultValue": { "description": "Default value of the parameter.", "type": "string", "readOnly": true, "x-omitempty": true }, "ParamValueType": { "description": "The object type of the configurable parameter value.", "type": "string", "readOnly": true, "x-omitempty": true }, "ValidValueRanges": { "type": "array", "items": { "description": "Valid values for the parameter.", "$ref": "#/components/schemas/hci.ConfigurableParamValueRange", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "hci.ConfigurableParamValueRange": { "title": "Hci:Configurable Param Value Range", "description": "Valid value range for a configurable parameter.", "x-allOf-name": "hci.ConfigurableParamValueRange", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ConfigurableParamValueRange', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ConfigurableParamValueRange" ], "default": "hci.ConfigurableParamValueRange", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ConfigurableParamValueRange" ], "default": "hci.ConfigurableParamValueRange", "x-enum-as-string": true }, "MaximumValue": { "description": "Maximum value the parameter can have.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinimumValue": { "description": "Minimum value the parameter can have.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.Consumption": { "title": "Hci:Consumption", "description": "A license's consumption detail by a cluster.", "x-allOf-name": "hci.Consumption", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Consumption', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Consumption" ], "default": "hci.Consumption", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.Consumption" ], "default": "hci.Consumption", "x-enum-as-string": true }, "ClusterExtId": { "description": "The id of the cluster that consume the license.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseId": { "description": "The id of the license instance being consumed.", "type": "string", "readOnly": true, "x-omitempty": true }, "QuantityUsed": { "description": "The quantity of a license consumed by the cluster.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true } } } ] }, "hci.Disk.Response": { "description": "The response body of a HTTP GET request for the 'hci.Disk' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.Disk' resources.", "x-one-of-name": "hci.Disk.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.Disk.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.Disk.Relationship": { "description": "A relationship to the 'hci.Disk' resource, or the expanded 'hci.Disk' resource, or the 'null' value.", "x-one-of-name": "hci.Disk.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.Disk" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.Disk": { "title": "Hci:Disk", "description": "The physical disk belonging to a node in a Nutanix cluster.\n#### Purpose\nThe Disk object provides a detailed view of disk configurations.\n#### Key Concepts\n- **Configuration Details:** Offers insights into disk attributes like storage tier, size, model, and status.\n- **Operational Status:** Monitors disk operational state and storage utilization.", "x-allOf-name": "hci.Disk", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Disk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Disk" ], "default": "hci.Disk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.Disk" ], "default": "hci.Disk", "x-enum-as-string": true }, "ClusterExtId": { "description": "The unique identifier of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterName": { "description": "The name of the cluster this disk belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "CvmIpAddress": { "description": "The IP address of the CVM.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "DiskExtId": { "description": "The unique identifier of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskSizeBytes": { "description": "The size of the disk in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FirmwareVersion": { "description": "The current firmware version of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "HasBootPartitionsOnly": { "description": "Indicates if the disk is boot only and no disk operation to be run on it.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "HostName": { "description": "The name of the host the disk is running on.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsBootDisk": { "description": "Indicate if the disk is a boot disk.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsDataMigrated": { "description": "Indicates whether the disk data is migrated.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsDiagnosticInfoAvailable": { "description": "Indicates whether the diagnostic information is available.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsErrorFoundInLogs": { "description": "Indicates whether the error is found in kernel logs.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsMarkedForRemoval": { "description": "Indicates whether the disk is marked for removal.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsMounted": { "description": "Indicates whether the disk is mounted.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsOnline": { "description": "Indicates whether the disk is online or offline.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsPasswordProtected": { "description": "The password protection status of the disk.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsPlannedOutage": { "description": "Indicates if diagnostics are running on the Disk.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsSelfEncryptingDrive": { "description": "The self-encrypting drive status of the disk.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsSelfManagedNvme": { "description": "Indicates if the NVMe Disk is self managed and no host/CVM reboot is required.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsSpdkManaged": { "description": "Indicates if NVMe device is managed by storage performance development \nkit (SPDK).", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsSuspectedUnhealthy": { "description": "Indicates whether the disk is suspected unhealthy.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsUnderDiagnosis": { "description": "Indicates whether the disk is under diagnosis.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsUnhealthy": { "description": "Indicates whether the disk is unhealthy.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Location": { "description": "The location of the disk in the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The model of the reported disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "MountPath": { "description": "The mount path of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeExtId": { "description": "The unique identifier of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeIpAddress": { "description": "The IP address of the node.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "NvmePciePath": { "description": "The PCIe path of the NVMe disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "PhysicalCapacityBytes": { "description": "The physical capacity of the disk in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "The serial number of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServiceVmId": { "description": "The unique identifier of the service VM on the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the disk such as NORMAL, MARKED_FOR_REMOVAL_BUT_NOT_DETACHABLE,\nDETACHABLE, DATA_MIGRATION_INITIATED.", "type": "string", "readOnly": true, "x-omitempty": true }, "StoragePoolExtId": { "description": "The unique identifier of the storage pool.", "type": "string", "readOnly": true, "x-omitempty": true }, "StorageTier": { "description": "The storage tier of the disk such as SSD_PCIE, SSD_SATA, DAS_SATA, CLOUD, SSD_MEM_NVME.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetFirmwareVersion": { "description": "The target firmware version of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "The vendor of the reported disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "Node": { "$ref": "#/components/schemas/hci.Node.Relationship", "description": "A reference to a hciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.Disk.List": { "title": "List of 'hci.Disk' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.Disk' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.Disk' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Disk" }, "nullable": true } } } ] }, "hci.DomainManager.Response": { "description": "The response body of a HTTP GET request for the 'hci.DomainManager' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.DomainManager' resources.", "x-one-of-name": "hci.DomainManager.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.DomainManager.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.DomainManager.Relationship": { "description": "A relationship to the 'hci.DomainManager' resource, or the expanded 'hci.DomainManager' resource, or the 'null' value.", "x-one-of-name": "hci.DomainManager.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.DomainManager" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.DomainManager": { "title": "Hci:Domain Manager", "description": "The DomainManager object represents the Nutanix Prism Central instance managing multiple clusters.\n#### Purpose \nThe DomainManager object reports basic information about the Nutanix Prism Central instance such as its name and size. It also is a parent object for all other entities managed by Prism Central, including clusters, nodes, VMs, GPUs, and licenses.\n#### Key Concepts\n- **Inventory Collection Limits:** The API limits property defines the maximum number of inventory objects that can be collected based on the current Prism Central resource configuration.\n- **Anchor point for resources in the Prism Central:** All HCI clusters registered with Prism Central, including the Prism Central cluster itself, along with their associated resources\u2014such as nodes, GPUs, VMs, and licenses.", "x-allOf-name": "hci.DomainManager", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.DomainManager', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.DomainManager" ], "default": "hci.DomainManager", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.DomainManager" ], "default": "hci.DomainManager", "x-enum-as-string": true }, "ApiLimits": { "type": "array", "items": { "description": "The collection of API limits.", "$ref": "#/components/schemas/hci.ApiLimit", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ApiLimitsString": { "description": "The string representation of the API limits as a string. It can be used by Alarm.", "type": "string", "readOnly": true, "x-omitempty": true }, "LcmConnectivityType": { "description": "The LCM (Life Cycle Manager) connectivity type. Possible values: CONNECTED_SITE (has internet connectivity), DARKSITE_DIRECT_UPLOAD (no external connectivity with direct upload), DARKSITE_WEB_SERVER (no external connectivity with darksite webserver).", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the domain manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "PcExtId": { "description": "The unique identifier of the domain manager (Prism Central) instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "The size of the domain manager such as STARTER, SMALL, LARGE, EXTRALARGE.\nIt determines the resources used by the domain manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "Clusters": { "description": "An array of relationships to hciCluster resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Cluster.Relationship" }, "nullable": true, "readOnly": true }, "Licenses": { "description": "An array of relationships to hciLicense resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.License.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.DomainManager.List": { "title": "List of 'hci.DomainManager' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.DomainManager' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.DomainManager' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.DomainManager" }, "nullable": true } } } ] }, "hci.Entitlement.Response": { "description": "The response body of a HTTP GET request for the 'hci.Entitlement' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.Entitlement' resources.", "x-one-of-name": "hci.Entitlement.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.Entitlement.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.Entitlement.Relationship": { "description": "A relationship to the 'hci.Entitlement' resource, or the expanded 'hci.Entitlement' resource, or the 'null' value.", "x-one-of-name": "hci.Entitlement.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.Entitlement" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.Entitlement": { "title": "Hci:Entitlement", "description": "The Entitlement object captures the details of license entitlements associated with clusters. This provides a structured representation of entitlement information.\n#### Purpose \nThe Entitlement object provides details of license entitlements associated with clusters.\n#### Key Concepts \n- **Entitlement of Licensed Features:** Provides insight into which features are provided by the licenses associated with the cluster. This includes how the features are entitled and their respective details.", "x-allOf-name": "hci.Entitlement", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Entitlement', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Entitlement" ], "default": "hci.Entitlement", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.Entitlement" ], "default": "hci.Entitlement", "x-enum-as-string": true }, "ClusterExtId": { "description": "The identifier of a license, usually in LIC-xxxx format.", "type": "string", "readOnly": true, "x-omitempty": true }, "Details": { "type": "array", "items": { "description": "The details of the entitlement.", "$ref": "#/components/schemas/hci.EntitlementDetail", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Type": { "description": "The type of the cluster which could be NUTANIX, VMWARE, or NON_NUTANIX.", "type": "string", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.Entitlement.List": { "title": "List of 'hci.Entitlement' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.Entitlement' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.Entitlement' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Entitlement" }, "nullable": true } } } ] }, "hci.EntitlementDetail": { "title": "Hci:Entitlement Detail", "description": "The detail of a license entitlement detail.", "x-allOf-name": "hci.EntitlementDetail", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.EntitlementDetail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.EntitlementDetail" ], "default": "hci.EntitlementDetail", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.EntitlementDetail" ], "default": "hci.EntitlementDetail", "x-enum-as-string": true }, "Category": { "description": "The category of the entitlement.", "type": "string", "readOnly": true, "x-omitempty": true }, "EarliestExpiryDate": { "description": "The earliest expiry date of the entitlement.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Meter": { "description": "The meter of the entitlement.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the entitlement.", "type": "string", "readOnly": true, "x-omitempty": true }, "Quantity": { "description": "The quantity of the entitlement.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "The scope of the entitlement.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubCategory": { "description": "The subCategory of the entitlement.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the license entitlement.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.EsxiGuestTools": { "title": "Hci:Esxi Guest Tools", "description": "The details of the Nutanix Guest Tools.", "x-allOf-name": "hci.EsxiGuestTools", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.EsxiGuestTools', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.EsxiGuestTools" ], "default": "hci.EsxiGuestTools", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.EsxiGuestTools" ], "default": "hci.EsxiGuestTools", "x-enum-as-string": true }, "AvailableVersion": { "description": "The available version of the Nutanix Guest Tools.", "type": "string", "readOnly": true, "x-omitempty": true }, "Capabilities": { "type": "array", "items": { "description": "The capabilities of the Nutanix Guest Tools.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "GuestOsVersion": { "description": "The guest OS version of the Nutanix Guest Tools.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsEnabled": { "description": "Indicates if the Nutanix Guest Tools is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsInstalled": { "description": "Indicates if the Nutanix Guest Tools is installed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsIsoInserted": { "description": "Indicates if the Nutanix Guest Tools ISO is inserted.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsReachable": { "description": "Indicates if the Nutanix Guest Tools is reachable.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsVmMobilityDriverInstalled": { "description": "Indicates if the Nutanix Guest Tools VM mobility driver is installed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsVssSnapshotCapable": { "description": "Indicates if the Nutanix Guest Tools is VSS snapshot capable.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the Nutanix Guest Tools.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.EsxiVm.Response": { "description": "The response body of a HTTP GET request for the 'hci.EsxiVm' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.EsxiVm' resources.", "x-one-of-name": "hci.EsxiVm.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.EsxiVm.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.EsxiVm.Relationship": { "description": "A relationship to the 'hci.EsxiVm' resource, or the expanded 'hci.EsxiVm' resource, or the 'null' value.", "x-one-of-name": "hci.EsxiVm.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.EsxiVm" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.EsxiVm": { "title": "Hci:Esxi Vm", "description": "An ESXi VM reported by Prism Central.", "x-allOf-name": "hci.EsxiVm", "allOf": [ { "$ref": "#/components/schemas/hci.BaseVm" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.EsxiVm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.EsxiVm" ], "default": "hci.EsxiVm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.EsxiVm" ], "default": "hci.EsxiVm", "x-enum-as-string": true }, "GuestTools": { "description": "The detail of the guest tools installed on the VM.", "$ref": "#/components/schemas/hci.EsxiGuestTools", "readOnly": true, "x-omitempty": true }, "VirtualHardwareVersion": { "description": "The virtual hardware version of the VM.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "Disks": { "description": "An array of relationships to hciEsxiVmDisk resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.EsxiVmDisk.Relationship" }, "nullable": true, "readOnly": true }, "Nics": { "description": "An array of relationships to hciEsxiVmNic resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.EsxiVmNic.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.EsxiVm.List": { "title": "List of 'hci.EsxiVm' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.EsxiVm' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.EsxiVm' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.EsxiVm" }, "nullable": true } } } ] }, "hci.EsxiVmDisk.Response": { "description": "The response body of a HTTP GET request for the 'hci.EsxiVmDisk' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.EsxiVmDisk' resources.", "x-one-of-name": "hci.EsxiVmDisk.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.EsxiVmDisk.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.EsxiVmDisk.Relationship": { "description": "A relationship to the 'hci.EsxiVmDisk' resource, or the expanded 'hci.EsxiVmDisk' resource, or the 'null' value.", "x-one-of-name": "hci.EsxiVmDisk.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.EsxiVmDisk" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.EsxiVmDisk": { "title": "Hci:Esxi Vm Disk", "description": "A disk associated with an ESXi VM.", "x-allOf-name": "hci.EsxiVmDisk", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.EsxiVmDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.EsxiVmDisk" ], "default": "hci.EsxiVmDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.EsxiVmDisk" ], "default": "hci.EsxiVmDisk", "x-enum-as-string": true }, "BusType": { "description": "The bus type of the disk. Possible values are 'IDE', 'SCSI', 'SATA', 'NVME'.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskExtId": { "description": "The unique identifier of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskSizeBytes": { "description": "The size of the disk in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Index": { "description": "The index of the disk, similar to a slot number on physical machine.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "IsFlashModeEnabled": { "description": "Indicates whether the virtual disk is pinned to the hot tier or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StorageContainerExtId": { "description": "The extId of the storage container which backs this disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "VmExtId": { "description": "The unique identifier of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 }, "Vm": { "$ref": "#/components/schemas/hci.EsxiVm.Relationship", "description": "A reference to a hciEsxiVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "hci.EsxiVmDisk.List": { "title": "List of 'hci.EsxiVmDisk' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.EsxiVmDisk' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.EsxiVmDisk' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.EsxiVmDisk" }, "nullable": true } } } ] }, "hci.EsxiVmNic.Response": { "description": "The response body of a HTTP GET request for the 'hci.EsxiVmNic' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.EsxiVmNic' resources.", "x-one-of-name": "hci.EsxiVmNic.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.EsxiVmNic.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.EsxiVmNic.Relationship": { "description": "A relationship to the 'hci.EsxiVmNic' resource, or the expanded 'hci.EsxiVmNic' resource, or the 'null' value.", "x-one-of-name": "hci.EsxiVmNic.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.EsxiVmNic" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.EsxiVmNic": { "title": "Hci:Esxi Vm Nic", "description": "A NIC associated with an ESXi VM.", "x-allOf-name": "hci.EsxiVmNic", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.EsxiVmNic', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.EsxiVmNic" ], "default": "hci.EsxiVmNic", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.EsxiVmNic" ], "default": "hci.EsxiVmNic", "x-enum-as-string": true }, "AdapterType": { "description": "The adapter type of the NIC. Possible values are 'E1000', 'E1000E', 'VMXNET', 'VMXNET2', 'VMXNET3', 'PCNET32', 'SRIOV'.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpAddresses": { "type": "array", "items": { "description": "The IP addresses of the NIC.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsConnected": { "description": "Indicates if the NIC is connected.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "The MAC address of the NIC.", "type": "string", "readOnly": true, "x-omitempty": true }, "NicExtId": { "description": "The unique identifier of the NIC.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortgroupName": { "description": "The name of the port group.", "type": "string", "readOnly": true, "x-omitempty": true }, "VmExtId": { "description": "The unique identifier of the VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "#/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 }, "Vm": { "$ref": "#/components/schemas/hci.EsxiVm.Relationship", "description": "A reference to a hciEsxiVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "hci.EsxiVmNic.List": { "title": "List of 'hci.EsxiVmNic' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.EsxiVmNic' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.EsxiVmNic' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.EsxiVmNic" }, "nullable": true } } } ] }, "hci.ExpiredLicense": { "title": "Hci:Expired License", "description": "The details of the expired license.", "x-allOf-name": "hci.ExpiredLicense", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ExpiredLicense', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ExpiredLicense" ], "default": "hci.ExpiredLicense", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ExpiredLicense" ], "default": "hci.ExpiredLicense", "x-enum-as-string": true }, "Category": { "description": "The category of the license that has expired.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExpiryDate": { "description": "The expiry date of the license that has expired.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ExtId": { "description": "The id of the license that has expired.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseId": { "description": "The id of the license that has expired.", "type": "string", "readOnly": true, "x-omitempty": true }, "Meter": { "description": "The meter of the license.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the license that has expired.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubCategory": { "description": "The subCategory of the license that has expired.", "type": "string", "readOnly": true, "x-omitempty": true }, "UsedQuantity": { "description": "The used quantity of the license.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "hci.ExternalStorage.Response": { "description": "The response body of a HTTP GET request for the 'hci.ExternalStorage' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.ExternalStorage' resources.", "x-one-of-name": "hci.ExternalStorage.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.ExternalStorage.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.ExternalStorage.Relationship": { "description": "A relationship to the 'hci.ExternalStorage' resource, or the expanded 'hci.ExternalStorage' resource, or the 'null' value.", "x-one-of-name": "hci.ExternalStorage.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.ExternalStorage" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.ExternalStorage": { "title": "Hci:External Storage", "description": "An external storage instance represents storage provided by external vendors such as Pure Storage that is used by Nutanix clusters.\n#### Purpose\nThe ExternalStorage object provides a view of external storage configuration and capacity, enabling administrators to monitor Pure Storage FlashArrays, pods, and realms integrated with Nutanix clusters.\n#### Key Concepts\n- **External Storage Integration:** Enables Nutanix clusters to utilize volumes from Pure Storage FlashArrays as underlying storage.\n- **Pod and Realm Support:** Tracks Pure Storage pods (consistency groups) and realms (logical groupings for ActiveCluster).\n- **Capacity Monitoring:** Reports total and free capacity of external storage resources.", "x-allOf-name": "hci.ExternalStorage", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ExternalStorage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ExternalStorage" ], "default": "hci.ExternalStorage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ExternalStorage" ], "default": "hci.ExternalStorage", "x-enum-as-string": true }, "ExternalStorageExtId": { "description": "The external identifier of the external storage instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "FreeCapacityBytes": { "description": "Free capacity of the external storage in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Health": { "description": "Health status of the external storage. Iris API does not populate health, Janus API does.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the external-storage instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "PodExtId": { "description": "Id of the pod this external-storage connects to.", "type": "string", "readOnly": true, "x-omitempty": true }, "PodName": { "description": "Name of the pod this external-storage connects to.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProviderType": { "description": "The type of storage provider. Normalized to EVERPURE_FLASHARRAY for Pure Storage\nFlashArray (API may return either PURE_STORAGE_FLASHARRAY or EVERPURE_FLASHARRAY).", "type": "string", "readOnly": true, "x-omitempty": true }, "PureArrayInfos": { "type": "array", "items": { "description": "Pure array list this external-storage connects to. For Iris release, there will be only one element in the list.", "$ref": "#/components/schemas/hci.ExternalStorageArray", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RealmName": { "description": "Realm of the pod this external-storage connects to.", "type": "string", "readOnly": true, "x-omitempty": true }, "TotalCapacityBytes": { "description": "Total capacity of the external storage in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PurePod": { "$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 }, "PureRealm": { "$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": "#/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 }, "StorageContainers": { "description": "An array of relationships to hciStorageContainer resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.StorageContainer.Relationship" }, "nullable": true, "readOnly": true }, "StorageSystems": { "description": "An array of relationships to storageBaseArray resources.", "type": "array", "items": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/storage.BaseArray.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "hci.ExternalStorage.List": { "title": "List of 'hci.ExternalStorage' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.ExternalStorage' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.ExternalStorage' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.ExternalStorage" }, "nullable": true } } } ] }, "hci.ExternalStorageArray": { "title": "Hci:External Storage Array", "description": "Information about a Pure Storage FlashArray that provides external storage to a Nutanix cluster.", "x-allOf-name": "hci.ExternalStorageArray", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ExternalStorageArray', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ExternalStorageArray" ], "default": "hci.ExternalStorageArray", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ExternalStorageArray" ], "default": "hci.ExternalStorageArray", "x-enum-as-string": true }, "ArrayExtId": { "description": "The external identifier of the Pure Storage FlashArray.", "type": "string", "readOnly": true, "x-omitempty": true }, "ArrayIpAddress": { "description": "The IP address or FQDN of the Pure Storage FlashArray this external-storage connects to.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true } } } ] }, "hci.FaultToleranceState": { "title": "Hci:Fault Tolerance State", "description": "The state of fault tolerance of a cluster.", "x-allOf-name": "hci.FaultToleranceState", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.FaultToleranceState', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.FaultToleranceState" ], "default": "hci.FaultToleranceState", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.FaultToleranceState" ], "default": "hci.FaultToleranceState", "x-enum-as-string": true }, "CurrentMaxFaultTolerance": { "description": "The maximum fault tolerance level that is supported currently.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "DesiredMaxFaultTolerance": { "description": "The maximum fault tolerance level that is desired.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "DomainAwarenessLevel": { "description": "Domain awareness level corresponds to unit of cluster group. Part of\npayload for both cluster create & update operations.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.FeatureViolation": { "title": "Hci:Feature Violation", "description": "The detailed violation of a feature.", "x-allOf-name": "hci.FeatureViolation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.FeatureViolation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.FeatureViolation" ], "default": "hci.FeatureViolation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.FeatureViolation" ], "default": "hci.FeatureViolation", "x-enum-as-string": true }, "AffectedEntity": { "description": "The description of the affected entity of this feature violation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "The description of the feature that has violation.", "type": "string", "readOnly": true, "x-omitempty": true }, "FeatureId": { "description": "The id of the feature that has violation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the feature that has violation.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.Gpu.Response": { "description": "The response body of a HTTP GET request for the 'hci.Gpu' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.Gpu' resources.", "x-one-of-name": "hci.Gpu.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.Gpu.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.Gpu.Relationship": { "description": "A relationship to the 'hci.Gpu' resource, or the expanded 'hci.Gpu' resource, or the 'null' value.", "x-one-of-name": "hci.Gpu.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.Gpu" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.Gpu": { "title": "Hci:Gpu", "description": "A GPU belonging to a node in a Nutanix cluster.\n#### Purpose\nThe Gpu object provides a detailed view of GPU configuration for a node in a Nutanix cluster.\n#### Key Concepts\n- **Configuration Details:** Offers insights into GPU attributes like model, associated node and cluster, and allocation of virtual GPUs.", "x-allOf-name": "hci.Gpu", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Gpu', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Gpu" ], "default": "hci.Gpu", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.Gpu" ], "default": "hci.Gpu", "x-enum-as-string": true }, "ClusterExtId": { "description": "The unique identifier of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterName": { "description": "The name of the cluster this GPU belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerVmId": { "description": "The unique identifier of the controller VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "GpuExtId": { "description": "The unique identifier of the gpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeExtId": { "description": "The unique identifier of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumberOfVgpusAllocated": { "description": "The number of vGPUs allocated.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VirtualGpuConfig": { "description": "The configuration of the virtual GPU.", "$ref": "#/components/schemas/hci.VirtualGpuConfig", "readOnly": true, "x-omitempty": true }, "Node": { "$ref": "#/components/schemas/hci.Node.Relationship", "description": "A reference to a hciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.Gpu.List": { "title": "List of 'hci.Gpu' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.Gpu' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.Gpu' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Gpu" }, "nullable": true } } } ] }, "hci.IpAddress": { "title": "Hci:Ip Address", "description": "An IP address that can be either IPv4 or IPv6.", "x-allOf-name": "hci.IpAddress", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.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": [ "hci.IpAddress" ], "default": "hci.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": [ "hci.IpAddress" ], "default": "hci.IpAddress", "x-enum-as-string": true }, "Ipv4Address": { "description": "An IPv4 address in this IpAddress.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv4PrefixLength": { "description": "The prefix length of the IPv4 address.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "Ipv6Address": { "description": "An IPv6 address in this IpAddress.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv6PrefixLength": { "description": "The prefix length of the IPv6 address.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true } } } ] }, "hci.IpAddressOrFqdn": { "title": "Hci:Ip Address Or Fqdn", "description": "An IP address that can be either IPv4 or IPv6.", "x-allOf-name": "hci.IpAddressOrFqdn", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.IpAddressOrFqdn', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.IpAddressOrFqdn" ], "default": "hci.IpAddressOrFqdn", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.IpAddressOrFqdn" ], "default": "hci.IpAddressOrFqdn", "x-enum-as-string": true }, "Fqdn": { "description": "The fully qualified domain name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv4Address": { "description": "An IPv4 address in this IpAddress.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv4PrefixLength": { "description": "The prefix length of the IPv4 address.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "Ipv6Address": { "description": "An IPv6 address in this IpAddress.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv6PrefixLength": { "description": "The prefix length of the IPv6 address.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true } } } ] }, "hci.KeyManagementDeviceToCertStatusInfo": { "title": "Hci:Key Management Device To Cert Status Info", "description": "The status of the certificate on the key management device.", "x-allOf-name": "hci.KeyManagementDeviceToCertStatusInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.KeyManagementDeviceToCertStatusInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.KeyManagementDeviceToCertStatusInfo" ], "default": "hci.KeyManagementDeviceToCertStatusInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.KeyManagementDeviceToCertStatusInfo" ], "default": "hci.KeyManagementDeviceToCertStatusInfo", "x-enum-as-string": true }, "KeyManagementServerName": { "description": "The name of the key management server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the certificate.", "type": "boolean", "readOnly": true, "x-omitempty": true } } } ] }, "hci.License.Response": { "description": "The response body of a HTTP GET request for the 'hci.License' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.License' resources.", "x-one-of-name": "hci.License.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.License.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.License.Relationship": { "description": "A relationship to the 'hci.License' resource, or the expanded 'hci.License' resource, or the 'null' value.", "x-one-of-name": "hci.License.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.License" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.License": { "title": "Hci:License", "description": "The License object captures the details of software licenses acquired by Nutanix Prism Central. This provides a structured representation of licenses for all entities managed by Prism Central.\n#### Purpose \nThe License object provides a detailed view of license information and status.\n#### Key Concepts \n- **License Representation:** Stores structured information about licenses acquired by Prism Central, including type, status, and validity details.\n- **Compliance Tracking:** Provides information on license usage and expiration.", "x-allOf-name": "hci.License", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.License', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.License" ], "default": "hci.License", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.License" ], "default": "hci.License", "x-enum-as-string": true }, "Category": { "description": "The category of a license instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConsumptionDetails": { "type": "array", "items": { "description": "The consumption details of a license instance.", "$ref": "#/components/schemas/hci.Consumption", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExpiryDate": { "description": "The expiry date of a license instance.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ExtId": { "description": "The unique identifier of a license.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseId": { "description": "The identifier of a license, usually in LIC-xxxx format.", "type": "string", "readOnly": true, "x-omitempty": true }, "Meter": { "description": "A license capacity is expressed in terms of meter.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of a license instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "PcExtId": { "description": "The unique identifier of the domain manager (Prism Central) instance which manages this cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "Quantity": { "description": "The scope defines where licenses can be applied.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "The scope defines where licenses can be applied.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubCategory": { "description": "The subCategory of a license instance, such as if it is an add-on or\nwith unlimited capacity.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of a license instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "DomainManager": { "$ref": "#/components/schemas/hci.DomainManager.Relationship", "description": "A reference to a hciDomainManager resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.License.List": { "title": "List of 'hci.License' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.License' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.License' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.License" }, "nullable": true } } } ] }, "hci.LicensedService": { "title": "Hci:Licensed Service", "description": "The compliance state of a licensed service.", "x-allOf-name": "hci.LicensedService", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.LicensedService', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.LicensedService" ], "default": "hci.LicensedService", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.LicensedService" ], "default": "hci.LicensedService", "x-enum-as-string": true }, "EnforcementActions": { "type": "array", "items": { "description": "The actions taken by the enforcement level.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "EnforcementLevel": { "description": "The level of enforcement applied on any violotions.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsCompliant": { "description": "Indicate if the service is in-compliance with the license type.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LicenseType": { "description": "The type of license used by the service.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the licensed service.", "type": "string", "readOnly": true, "x-omitempty": true }, "Violations": { "type": "array", "items": { "description": "The violations detected by the enforcement level.", "$ref": "#/components/schemas/hci.ServiceViolation", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "hci.ManagementServer": { "title": "Hci:Management Server", "description": "The management server of a cluster.", "x-allOf-name": "hci.ManagementServer", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ManagementServer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ManagementServer" ], "default": "hci.ManagementServer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ManagementServer" ], "default": "hci.ManagementServer", "x-enum-as-string": true }, "DrsEnabled": { "description": "Is DRS enabled on the management server.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "InUse": { "description": "Indicates if the management server is in use.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Ip": { "description": "The IP address of the management server.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "IsRegistered": { "description": "Is the management server registered.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The fully qualified domain name of the management server.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.NccCheckPolicy.Response": { "description": "The response body of a HTTP GET request for the 'hci.NccCheckPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.NccCheckPolicy' resources.", "x-one-of-name": "hci.NccCheckPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.NccCheckPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.NccCheckPolicy": { "title": "Hci:Ncc Check Policy", "description": "A Nutanix Cluster Check (NCC) policy configured on the Prism Central.", "x-allOf-name": "hci.NccCheckPolicy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.NccCheckPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.NccCheckPolicy" ], "default": "hci.NccCheckPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.NccCheckPolicy" ], "default": "hci.NccCheckPolicy", "x-enum-as-string": true }, "Classifications": { "type": "array", "items": { "description": "Category into which this alert type can be classified.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ClusterConfigs": { "type": "array", "items": { "description": "The NCC policy parameters for the cluster.", "$ref": "#/components/schemas/hci.SdaPolicyClusterConfig", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Description": { "description": "NCC policy description text.", "type": "string", "readOnly": true, "x-omitempty": true }, "EntityType": { "description": "Entity type against which the alert is raised.", "type": "string", "readOnly": true, "x-omitempty": true }, "ImpactType": { "description": "Impact type to which this rule applies.", "type": "string", "readOnly": true, "x-omitempty": true }, "KbArticles": { "type": "array", "items": { "description": "List of knowledge base article numbers associated with the NCC policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "The name of the NCC policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "NccPolicyExtId": { "description": "Unique ID of the NCC policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PcExtId": { "description": "Unique identifier of the domain manager (Prism Central) instance which owns this policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyId": { "description": "Unique ID associated with the policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Publisher": { "description": "Publisher of the NCC policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "Scope for the polcy execution.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubType": { "description": "Sub-type classification of the NCC policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetClusters": { "type": "array", "items": { "description": "Indicate the cluster type against which the policy can be executed.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Title": { "description": "The title of the NCC policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Defines the type of the NCC policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "DomainManager": { "$ref": "#/components/schemas/hci.DomainManager.Relationship", "description": "A reference to a hciDomainManager resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.NccCheckPolicy.List": { "title": "List of 'hci.NccCheckPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.NccCheckPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.NccCheckPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.NccCheckPolicy" }, "nullable": true } } } ] }, "hci.NccConfigurableParameter": { "title": "Hci:Ncc Configurable Parameter", "description": "NCC policy parameters that is configurable by a user.", "x-allOf-name": "hci.NccConfigurableParameter", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.NccConfigurableParameter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.NccConfigurableParameter" ], "default": "hci.NccConfigurableParameter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.NccConfigurableParameter" ], "default": "hci.NccConfigurableParameter", "x-enum-as-string": true }, "Name": { "description": "Unique identifier name for the parameter.", "type": "string", "readOnly": true, "x-omitempty": true }, "ParamValue": { "description": "Configured value for the parameter.", "$ref": "#/components/schemas/hci.ConfigurableParamValue", "readOnly": true, "x-omitempty": true }, "Unit": { "description": "Unit of measurement for the parameter.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.Node.Response": { "description": "The response body of a HTTP GET request for the 'hci.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 'hci.Node' resources.", "x-one-of-name": "hci.Node.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.Node.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.Node.Relationship": { "description": "A relationship to the 'hci.Node' resource, or the expanded 'hci.Node' resource, or the 'null' value.", "x-one-of-name": "hci.Node.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.Node" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.Node": { "title": "Hci:Node", "description": "The Node object encapsulates the details of individual nodes within clusters, as reported by Nutanix Prism Central. This provides a structured representation of nodes, including their configuration and operational status.\n#### Purpose \nThe Node object provides a detailed view of node configurations. \n#### Key Concepts \n- **Configuration Details:** Offers insights into node attributes like hypervisor type, model details, host type, and associated objects like disks and VMs.\n- **Operational Status:** Monitors node health, operational states, and resource utilization.\n- **Server Linkage:** The PhysicalServer property on the node object provides a link to the actual server, if the server is claimed in Intersight.", "x-allOf-name": "hci.Node", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.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": [ "hci.Node" ], "default": "hci.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": [ "hci.Node" ], "default": "hci.Node", "x-enum-as-string": true }, "BlockModel": { "description": "The rackable unit model of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "BlockSerial": { "description": "The rackable unit serial number of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "BootTimeUsecs": { "description": "The boot time in microseconds of the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ClusterExtId": { "description": "The unique identifier of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterName": { "description": "The name of the cluster this node belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerVmBackplaneAddress": { "description": "The backplane IP address of the controller VM.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "ControllerVmExternalAddress": { "description": "The external IP address of the controller VM.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "ControllerVmId": { "description": "The identifier number of the controller VM.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "ControllerVmMaintanenceMode": { "description": "The maintenance mode status of the controller VM.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ControllerVmNatIp": { "description": "The NAT IP address of the controller VM.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "ControllerVmNatPort": { "description": "The NAT port of the controller VM.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "ControllerVmRdmaBackplaneAddress": { "description": "The RDMA backplane IP address of the controller VM.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "ControllerVmServerUuid": { "description": "The Rackable unit UUID of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "CpuCapacityHz": { "description": "The CPU capacity in Hz of the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CpuFrequencyHz": { "description": "The CPU frequency in Hz on the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CpuModel": { "description": "The CPU model of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "CpuUsageHz": { "description": "The CPU usage in Hz of the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DefaultVhdContainerUuid": { "description": "The default VHD container UUID of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultVhdLocation": { "description": "The default VHD location of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultVmContainerUuid": { "description": "The default VM container UUID of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultVmLocation": { "description": "The default VM location of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskCount": { "description": "The number of disks on the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FailoverClusterFqdn": { "description": "The failover cluster FQDN of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "FailoverClusterNodeStatus": { "description": "The failover cluster node status of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "GpuCount": { "description": "The number of GPUs on the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "GpuDriverVersion": { "description": "The GPU driver version of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "HasCsr": { "description": "Certificate signing request status of the node.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "HostName": { "description": "The name of the host the node is running on.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostType": { "description": "The type of the host, e.g. HYPER_CONVERGED, COMPUTE_ONLY, STORAGE_ONLY.", "type": "string", "readOnly": true, "x-omitempty": true }, "HypervisorAcropolisConnectionState": { "description": "The connection state of the hypervisor, e.g. CONNECTED, DISCONNECTED, NOT_AVAILABLE.", "type": "string", "readOnly": true, "x-omitempty": true }, "HypervisorExternalAddress": { "description": "The external IP address of the hypervisor on this node.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "HypervisorNumberOfVms": { "description": "The number of VMs managed on this node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HypervisorState": { "description": "The hypervisor state e.g. ACROPOLIS_NORMAL, ENTERING_MAINTENANCE_MODE,\nENTERED_MAINTENANCE_MODE, RESERVED_FOR_HA_FAILOVER, ENTERING_MAINTENANCE_MODE_FROM_HA_FAILOVER,\nRESERVING_FOR_HA_FAILOVER, HA_FAILOVER_SOURCE, HA_FAILOVER_TARGET, HA_HEALING_SOURCE,\nHA_HEALING_TARGET.", "type": "string", "readOnly": true, "x-omitempty": true }, "HypervisorType": { "description": "The hypervisor type, e.g. AHV, ESX, HYPERV, XEN, NATIVEHOST etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "HypervisorUserName": { "description": "The user name of the hypervisor on this node.", "type": "string", "readOnly": true, "x-omitempty": true }, "HypervisorVersion": { "description": "The version of the hypervisor on this node.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpmiIp": { "description": "The IPMI IP address of the controller.", "$ref": "#/components/schemas/hci.IpAddress", "readOnly": true, "x-omitempty": true }, "IpmiUsername": { "description": "The IPMI user name of the controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsDegraded": { "description": "The degraded status of the node.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsHardwareVirtualized": { "description": "The hardware virtualization status of the node.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsSecureBooted": { "description": "The secure boot status of the node.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "KeyManagementDeviceToCertStatus": { "type": "array", "items": { "description": "The status of the certificate on the key management device.", "$ref": "#/components/schemas/hci.KeyManagementDeviceToCertStatusInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MaintenanceState": { "description": "The maintenance state of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "MemoryCapacityBytes": { "description": "The memory capacity in bytes of the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MemorySizeBytes": { "description": "The memory size in bytes of the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MemoryUsageBytes": { "description": "The memory usage in bytes of the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NodeExtId": { "description": "The unique identifier of the node.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeSerial": { "description": "The serial number of this node.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeStatus": { "description": "The status of the node such as NORMAL, TO_BE_REMOVED, OK_TO_BE_REMOVED,\nNEW_NODE, TO_BE_PREPROTECTED, PREPROTECTED.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumberOfCpuCores": { "description": "The number of CPU cores on the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumberOfCpuSockets": { "description": "The number of sockets on the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumberOfCpuThreads": { "description": "The number of threads on the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RebootPending": { "description": "The reboot pending status of the node.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StorageCapacityBytes": { "description": "The storage capacity in bytes of the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageUsageBytes": { "description": "The storage usage in bytes of the node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Disks": { "description": "An array of relationships to hciDisk resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Disk.Relationship" }, "nullable": true, "readOnly": true }, "Gpus": { "description": "An array of relationships to hciGpu resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Gpu.Relationship" }, "nullable": true, "readOnly": true }, "PhysicalServer": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/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 }, "RegisteredDevice": { "$ref": "#/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 }, "Vms": { "description": "An array of relationships to hciBaseVm resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.BaseVm.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "hci.Node.List": { "title": "List of 'hci.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.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 'hci.Node' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Node" }, "nullable": true } } } ] }, "hci.NutanixClusterCheck": { "title": "Hci:Nutanix Cluster Check", "description": "Configuration for Nutanix Cluster Check (NCC) operation. NCC is a diagnostic tool that validates cluster health.", "x-allOf-name": "hci.NutanixClusterCheck", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.NutanixClusterCheck', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.NutanixClusterCheck" ], "default": "hci.NutanixClusterCheck", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.NutanixClusterCheck" ], "default": "hci.NutanixClusterCheck", "x-enum-as-string": true }, "Action": { "description": "The action to perform. Possible values:\n- Run: Trigger NCC execution.\n- None: No action (default after workflow starts).\n* `None` - No action. Default state after a workflow starts or when no operation is requested.\n* `Run` - Trigger NCC check execution.", "type": "string", "enum": [ "None", "Run" ], "default": "None", "x-omitempty": true }, "AdditionalRecipients": { "type": "array", "items": { "description": "Email addresses to receive NCC results (in addition to cluster admin).\nMust be valid email addresses as per RFC 5322.", "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 }, "AnonymizeOutput": { "description": "Anonymize sensitive information in the check results.\nAlways set to true for security.", "type": "boolean", "default": true, "x-omitempty": true }, "CheckIds": { "type": "array", "items": { "description": "List of specific NCC IDs to run. Maximum 50 NCC IDs allowed.\nMutually exclusive with runAllChecks.", "type": "string", "x-omitempty": true }, "nullable": true }, "RunAllChecks": { "description": "When true, runs all available NCC checks. Mutually exclusive with checkIds.", "type": "boolean", "default": false, "x-omitempty": true }, "SendToConfiguredRecipients": { "description": "Send check run summary to cluster's configured email addresses.", "type": "boolean", "default": true, "x-omitempty": true } } } ] }, "hci.PendingWorkflowTrigger": { "title": "Hci:Pending Workflow Trigger", "description": "Tracking entry for an async workflow trigger awaiting callback response.", "x-allOf-name": "hci.PendingWorkflowTrigger", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.PendingWorkflowTrigger', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.PendingWorkflowTrigger" ], "default": "hci.PendingWorkflowTrigger", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.PendingWorkflowTrigger" ], "default": "hci.PendingWorkflowTrigger", "x-enum-as-string": true }, "TriggerTime": { "description": "The timestamp when the workflow trigger request was sent.\nUsed for timeout detection (default timeout: 20 minutes).", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "WorkflowType": { "description": "The workflow type identifier for the pending operation. Example: \"hci.NutanixClusterCheck\".", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.PhysicalGpu.Response": { "description": "The response body of a HTTP GET request for the 'hci.PhysicalGpu' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.PhysicalGpu' resources.", "x-one-of-name": "hci.PhysicalGpu.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.PhysicalGpu.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.PhysicalGpu.Relationship": { "description": "A relationship to the 'hci.PhysicalGpu' resource, or the expanded 'hci.PhysicalGpu' resource, or the 'null' value.", "x-one-of-name": "hci.PhysicalGpu.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.PhysicalGpu" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.PhysicalGpu": { "title": "Hci:Physical Gpu", "description": "Physical GPU managed by a cluster and reported by Prism Central.", "x-allOf-name": "hci.PhysicalGpu", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.PhysicalGpu', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.PhysicalGpu" ], "default": "hci.PhysicalGpu", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.PhysicalGpu" ], "default": "hci.PhysicalGpu", "x-enum-as-string": true }, "AllocatedVmExtIds": { "type": "array", "items": { "description": "The collection of VMs that has allocation from this physical GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Assignable": { "description": "If the GPU resources is available to be allocated to virtual machines (VMs) \nwithin this cluster.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ClusterExtId": { "description": "The unique identifier of the cluster which owns this physical GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "The GPU type of the physical GPU in an integer format. It is similar to DeviceName\nwhich shows the GPU type in string format.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "DeviceName": { "description": "The GPU type of the physical GPU in string format. It is similar to DeviceId which shows the GPU type in integer format.", "type": "string", "readOnly": true, "x-omitempty": true }, "FrameBufferSizeBytes": { "description": "The frame buffer size in bytes of the physical GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IsInUse": { "description": "The in use status of the physical GPU.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Mode": { "description": "The mode of the physical GPU. Possible values are - UNUSED, USED_FOR_PASSTHROUGH, USED_FOR_VIRTUAL.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumaNode": { "description": "Each GPU in a system may be physically connected to a specific CPU socket or NUMA node. \nThe numaNode value specifies which node the GPU is associated with. \nIn a NUMA system, a computer's memory is divided into multiple nodes. Each node is a \ncombination of processors and a portion of the system's memory. While processors can \naccess memory from all nodes, they have faster access to the memory in their own node \ncompared to memory in other nodes.", "type": "string", "readOnly": true, "x-omitempty": true }, "PhysicalGpuExtId": { "description": "The unique identifier of the physical GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sbdf": { "description": "The SBDF address of the physical GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the physical GPU. Possible values are PASSTHROUGH_GRAPHICS, PASSTHROUGH_COMPUTE, VIRTUAL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "The vendor name of the physical GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "AllocatedVms": { "description": "An array of relationships to hciBaseVm resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.BaseVm.Relationship" }, "nullable": true, "readOnly": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.PhysicalGpu.List": { "title": "List of 'hci.PhysicalGpu' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.PhysicalGpu' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.PhysicalGpu' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.PhysicalGpu" }, "nullable": true } } } ] }, "hci.PulseStatus": { "title": "Hci:Pulse Status", "description": "The pulse status of a cluster.", "x-allOf-name": "hci.PulseStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.PulseStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.PulseStatus" ], "default": "hci.PulseStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.PulseStatus" ], "default": "hci.PulseStatus", "x-enum-as-string": true }, "Enabled": { "description": "The status of the pulse service.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "PiiScrubbingLevel": { "description": "PII Scrubbing Level for pulse. It describe at what level the pulse data is collected.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.Sbdf": { "title": "Hci:Sbdf", "description": "The Segment:Bus:Device.Function (SBDF) hardware address.", "x-allOf-name": "hci.Sbdf", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Sbdf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Sbdf" ], "default": "hci.Sbdf", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.Sbdf" ], "default": "hci.Sbdf", "x-enum-as-string": true }, "Bus": { "description": "PCI Bus number information.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "Device": { "description": "PCI Device number information.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "Func": { "description": "PCI Function number information.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "Segment": { "description": "PCI's Segment information.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true } } } ] }, "hci.SdaPolicyClusterConfig": { "title": "Hci:Sda Policy Cluster Config", "description": "NCC Policy parameters for specific cluster.", "x-allOf-name": "hci.SdaPolicyClusterConfig", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.SdaPolicyClusterConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.SdaPolicyClusterConfig" ], "default": "hci.SdaPolicyClusterConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.SdaPolicyClusterConfig" ], "default": "hci.SdaPolicyClusterConfig", "x-enum-as-string": true }, "ClusterExtId": { "description": "Unique ID of the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigurableParameters": { "type": "array", "items": { "description": "Parameters of the NCC policy that are configurable by a user.", "$ref": "#/components/schemas/hci.NccConfigurableParameter", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsEnabled": { "description": "Indicates whether the NCC policy is enabled or not on the cluster.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LastModifiedTime": { "description": "Time in ISO 8601 format when the NCC policy was last modified.", "type": "string", "readOnly": true, "x-omitempty": true }, "ScheduleIntervalSeconds": { "description": "Interval in seconds for periodically executing the NCC policy.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true } } } ] }, "hci.ServiceViolation": { "title": "Hci:Service Violation", "description": "A instance of a service violation.", "x-allOf-name": "hci.ServiceViolation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.ServiceViolation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.ServiceViolation" ], "default": "hci.ServiceViolation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.ServiceViolation" ], "default": "hci.ServiceViolation", "x-enum-as-string": true }, "StartDate": { "description": "The start date of the violation.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the service violation. The possible values are:\n'LICENSE_EXPIRED', 'FEATURE_VIOLATION', 'CAPACITY_VIOLATION'.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.SoftwareType": { "title": "Hci:Software Type", "description": "The type and version information of a software.", "x-allOf-name": "hci.SoftwareType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.SoftwareType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.SoftwareType" ], "default": "hci.SoftwareType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.SoftwareType" ], "default": "hci.SoftwareType", "x-enum-as-string": true }, "SoftwareType": { "description": "The type of the software.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the software.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hci.StorageContainer.Response": { "description": "The response body of a HTTP GET request for the 'hci.StorageContainer' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.StorageContainer' resources.", "x-one-of-name": "hci.StorageContainer.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.StorageContainer.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.StorageContainer.Relationship": { "description": "A relationship to the 'hci.StorageContainer' resource, or the expanded 'hci.StorageContainer' resource, or the 'null' value.", "x-one-of-name": "hci.StorageContainer.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.StorageContainer" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.StorageContainer": { "title": "Hci:Storage Container", "description": "Storage containers in Nutanix serve as logical abstraction layers for virtual disk storage which can be backed by HCI (local) storage or external storage provided by vendors such as Pure Storage.\n#### Purpose\nThe StorageContainer object provides a view of both HCI and external storage containers in a Nutanix cluster, enabling administrators to monitor storage configuration and capacity.\n#### Key Concepts\n- **Storage Abstraction:** Logical containers for virtual disk storage that can use local or external storage backends.\n- **Capacity Management:** Tracks physical and logical capacity, reservations, and utilization metrics.\n- **Data Efficiency:** Supports compression, deduplication, and erasure coding for optimized storage usage.", "x-allOf-name": "hci.StorageContainer", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.StorageContainer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.StorageContainer" ], "default": "hci.StorageContainer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.StorageContainer" ], "default": "hci.StorageContainer", "x-enum-as-string": true }, "CacheDeduplication": { "description": "Current status of Cache Deduplication for the Storage Container. Possible values: ON, OFF. Does not apply to external storage container case.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterExtId": { "description": "The external identifier of the cluster owning the Storage Container.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterName": { "description": "The corresponding name of the cluster owning the Storage Container instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "CompressionDelaySecs": { "description": "The compression delay in seconds. Does not apply to external storage container case.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "ErasureCode": { "description": "Current status value of Erasure Coding for the Storage Container. Possible values: ON, OFF.\nNote: Erasure coding is available with certain licensing levels (e.g., Pro licensing or above). Does not apply to external storage container case.", "type": "string", "readOnly": true, "x-omitempty": true }, "ErasureCodeDelaySecs": { "description": "Delay in performing Erasure Code for the current Storage Container instance. Does not apply to external storage container case.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "ExternalStorageExtId": { "description": "External Storage extId. Presence of externalStorageExtId indicates this storage-container is an external storage container instead of a HCI storage container.", "type": "string", "readOnly": true, "x-omitempty": true }, "HasHigherEcFaultDomainPreference": { "description": "Indicates whether to prefer a higher Erasure Code fault domain. Does not apply to external storage container case.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsCompressionEnabled": { "description": "Indicates whether the compression is enabled for the Storage Container. Does not apply to external storage container case.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsEncrypted": { "description": "Indicates whether the Storage Container is encrypted or not. Does not apply to external storage container case.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsExternalStorage": { "description": "Derived value to indicate if the container is backed by an external storage or not. The value is true when the externalStorageExtId is not empty.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsInlineEcEnabled": { "description": "Indicates whether data written to this Storage Container should be inline erasure-coded or not. This field is only considered if ErasureCoding is enabled. Inline Erasure-Coded refers to a data protection method where erasure coding is applied directly and immediately to data as it is written (in-line) to the storage system. Does not apply to external storage container case.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsInternal": { "description": "Indicates whether the Storage Container is internal and is managed by Nutanix.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsMarkedForRemoval": { "description": "Indicates whether the Storage Container is marked for removal. This field is set when the Storage Container is about to be destroyed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsNfsAllowlistInherited": { "description": "Indicates whether the NFS allowlist is inherited from the global configuration. Does not apply to external storage container case.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsShared": { "description": "Indicates whether the Storage Container is shared. When shared, all PEs registered under the same PC can access and utilize its storage. Once the field is set during the creation, it is immutable except in the case of SelfServiceContainer. Even for SelfServiceContainer only FALSE to TRUE is allowed. Does not apply to external storage container case.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsSoftwareEncryptionEnabled": { "description": "Indicates whether the Storage Container instance has software encryption enabled. Does not apply to external storage container case.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LogicalAdvertisedCapacityBytes": { "description": "Maximum capacity of the Storage Container as defined by the user. Does not apply to external storage container case.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LogicalExplicitReservedCapacityBytes": { "description": "Total reserved size (in bytes) of the Storage Container (set by Admin). This also includes the replication factor of the Storage Container. The actual reserved capacity of the Storage Container will be the maximum of explicitReservedCapacity and implicitReservedCapacity. Does not apply to external storage container case.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LogicalImplicitReservedCapacityBytes": { "description": "Sum of the reservations provisioned on all vDisks in the Storage Container. The actual reserved capacity of the Storage Container will be the maximum of explicitReservedCapacity and implicitReservedCapacity. Does not apply to external storage container case.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MaxCapacityBytes": { "description": "Maximum physical capacity of the Storage Container in bytes. Does not apply to external storage container case.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the Storage Container. Prism Central requires that the name of Storage Container should be unique in every registered cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "OnDiskDedup": { "description": "Current status of Disk deduplication for the Storage Container. Possible values:\n- POST_PROCESS: Deduplication is enabled for the Storage Container instance.\n- OFF: Deduplication is disabled for the Storage Container instance.\nDoes not apply to external storage container case.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReplicationFactor": { "description": "Replication factor of the Storage Container. Does not apply to external storage container case.", "type": "integer", "format": "int32", "readOnly": true, "x-omitempty": true }, "StorageContainerExtId": { "description": "The external identifier of the Storage Container.", "type": "string", "readOnly": true, "x-omitempty": true }, "StoragePoolExtId": { "description": "The external identifier of the Storage Pool owning the Storage Container instance. Does not apply to external storage container case.", "type": "string", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ExternalStorage": { "$ref": "#/components/schemas/hci.ExternalStorage.Relationship", "description": "A reference to a hciExternalStorage resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.StorageContainer.List": { "title": "List of 'hci.StorageContainer' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.StorageContainer' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.StorageContainer' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.StorageContainer" }, "nullable": true } } } ] }, "hci.Violation.Response": { "description": "The response body of a HTTP GET request for the 'hci.Violation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.Violation' resources.", "x-one-of-name": "hci.Violation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.Violation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.Violation.Relationship": { "description": "A relationship to the 'hci.Violation' resource, or the expanded 'hci.Violation' resource, or the 'null' value.", "x-one-of-name": "hci.Violation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.Violation" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.Violation": { "title": "Hci:Violation", "description": "The Violation object identifies instances of license violations within Nutanix Prism Central. This provides information for tracking license violation issues.\n#### Purpose \nThe Violation object provides a view of license violations on the cluster. It reports features which exceed their licensed capacity as well as expired licenses.\n#### Key Concepts \n- **Compliance Monitoring:** Tracks instances of license violations, supporting timely resolution. \n- **Issue Management:** Provides insights into feature and capacity violations, aiding in corrective actions.", "x-allOf-name": "hci.Violation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.Violation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.Violation" ], "default": "hci.Violation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.Violation" ], "default": "hci.Violation", "x-enum-as-string": true }, "CapacityViolations": { "type": "array", "items": { "description": "The collection of capacity violations.", "$ref": "#/components/schemas/hci.CapacityViolation", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ClusterExtId": { "description": "The unique identifier of the cluster that has the violations.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExpiredLicenses": { "type": "array", "items": { "description": "The collection of expired licenses.", "$ref": "#/components/schemas/hci.ExpiredLicense", "readOnly": true, "x-omitempty": true }, "nullable": true }, "FeatureViolations": { "type": "array", "items": { "description": "The collection of feature violations.", "$ref": "#/components/schemas/hci.FeatureViolation", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsMulticluster": { "description": "Indicates if the violation is on multi-cluster which is PrismCentral in Nutanix's term.\nOtherwise, it is on a Prism Element cluster.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.Violation.List": { "title": "List of 'hci.Violation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.Violation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.Violation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.Violation" }, "nullable": true } } } ] }, "hci.VirtualGpu.Response": { "description": "The response body of a HTTP GET request for the 'hci.VirtualGpu' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hci.VirtualGpu' resources.", "x-one-of-name": "hci.VirtualGpu.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hci.VirtualGpu.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hci.VirtualGpu.Relationship": { "description": "A relationship to the 'hci.VirtualGpu' resource, or the expanded 'hci.VirtualGpu' resource, or the 'null' value.", "x-one-of-name": "hci.VirtualGpu.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hci.VirtualGpu" } ], "discriminator": { "propertyName": "ClassId" } }, "hci.VirtualGpu": { "title": "Hci:Virtual Gpu", "description": "Virtual GPU managed by a cluster and reported by Prism Central.", "x-allOf-name": "hci.VirtualGpu", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.VirtualGpu', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.VirtualGpu" ], "default": "hci.VirtualGpu", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.VirtualGpu" ], "default": "hci.VirtualGpu", "x-enum-as-string": true }, "AllocatedVmExtIds": { "type": "array", "items": { "description": "The collection of VMs that has allocation from this virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Assignable": { "description": "If the GPU resources is available to be allocated to virtual machines (VMs) \nwithin this cluster.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ClusterExtId": { "description": "The unique identifier of the cluster which owns this virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "The GPU type of the virtual GPU in an integer format. It is similar to DeviceName \nwhich shows the GPU type in string format.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DeviceName": { "description": "The GPU type of the virtual GPU in string format. It is similar to DeviceId which shows the GPU type in integer format.", "type": "string", "readOnly": true, "x-omitempty": true }, "Fraction": { "description": "The fraction of the physical GPU assigned.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FrameBufferSizeBytes": { "description": "The frame buffer size in bytes of the virtual GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "GuestDriverVersion": { "description": "The guest driver version of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsInUse": { "description": "The in use status of the virtual GPU.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Licenses": { "type": "array", "items": { "description": "The licenses associated with the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MaxInstancesPerVm": { "description": "The maximum instances per VM of the virtual GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MaxResolution": { "description": "The maximum resolution of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumaNode": { "description": "Each GPU in a system may be physically connected to a specific CPU socket or NUMA node. \nThe numaNode value specifies which node the GPU is associated with. \nIn a NUMA system, a computer's memory is divided into multiple nodes. Each node is a \ncombination of processors and a portion of the system's memory. While processors can \naccess memory from all nodes, they have faster access to the memory in their own node \ncompared to memory in other nodes.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumberOfVirtualDisplayHeads": { "description": "The number of virtual display heads of the virtual GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Sbdf": { "description": "The SBDF address of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the irtual GPU. Possible values are PASSTHROUGH_GRAPHICS, PASSTHROUGH_COMPUTE, VIRTUAL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "The vendor name of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualGpuExtId": { "description": "The unique identifier of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "AllocatedVms": { "description": "An array of relationships to hciBaseVm resources.", "type": "array", "items": { "$ref": "#/components/schemas/hci.BaseVm.Relationship" }, "nullable": true, "readOnly": true }, "Cluster": { "$ref": "#/components/schemas/hci.Cluster.Relationship", "description": "A reference to a hciCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "hci.VirtualGpu.List": { "title": "List of 'hci.VirtualGpu' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hci.VirtualGpu' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hci.VirtualGpu' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hci.VirtualGpu" }, "nullable": true } } } ] }, "hci.VirtualGpuConfig": { "title": "Hci:Virtual Gpu Config", "description": "The configuration of a virtual GPU.", "x-allOf-name": "hci.VirtualGpuConfig", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hci.VirtualGpuConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hci.VirtualGpuConfig" ], "default": "hci.VirtualGpuConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hci.VirtualGpuConfig" ], "default": "hci.VirtualGpuConfig", "x-enum-as-string": true }, "Assignable": { "description": "Indicates if the virtual GPU is assignable.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "The device id of the virtual GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DeviceName": { "description": "The name of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "Fraction": { "description": "The fraction of the virtual GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FrameBufferSizeBytes": { "description": "The frame buffer size of the virtual GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "GuestDriverVersion": { "description": "The guest driver version of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "InUse": { "description": "Indicates if the virtual GPU is in use.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Licenses": { "type": "array", "items": { "description": "The list of licenses of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MaxResolution": { "description": "The maximum resolution per display heads.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mode": { "description": "The mode of the virtual GPU such as UNUSED, USED_FOR_PASSTHROUGH, USED_FOR_VIRTUAL.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumaNode": { "description": "The NUMA node of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumberOfVirtualDisplayHeads": { "description": "The number of virtual display heads of the virtual GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Sbdf": { "description": "The SBDF address of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the virtual GPU such as PASS_THROUGH_GRAPHICS,\nPASS_THROUGH_COMPUTE, VIRTUAL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "The vendor name of the virtual GPU.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hcl.CompatibilityStatus": { "title": "Hcl:Compatibility Status", "description": "The CompatibilityStatus object evaluates the compatibility of hardware and software configurations within the system. This provides insights into the compatibility status of various configurations, aiding in decision-making and system optimization.\n#### Purpose\nCompatibilityStatus is integral to ensuring that hardware and software components are compatible with each other. It facilitates the evaluation of configurations to determine their suitability for deployment within the system.\n#### Key Concepts\n- **Configuration Evaluation:** Enables the assessment of compatibility across diverse hardware and software configurations, helping to identify potential issues before deployment.\n- **Request Types:** Offers flexible request types to serve different compatibility evaluation needs, from checking compatibility to filling supported version details.\n- **Access Control:** Privilege sets dictate who can interact with the CompatibilityStatus object, ensuring secure and appropriate usage.\n- **Entitlements and Licenses:** Operates under specific entitlements, aligning with organizational policies and ensuring compliance with licensing requirements.", "x-allOf-name": "hcl.CompatibilityStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.CompatibilityStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.CompatibilityStatus" ], "default": "hcl.CompatibilityStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.CompatibilityStatus" ], "default": "hcl.CompatibilityStatus", "x-enum-as-string": true }, "ProfileList": { "type": "array", "items": { "description": "List of HardwareCompatibilityProfiles for which the compatibility status needs to be computed.", "$ref": "#/components/schemas/hcl.HardwareCompatibilityProfile", "x-omitempty": true }, "minItems": 1, "nullable": true }, "RequestType": { "description": "Type of the request to be served.\n* `FillSupportedVersions` - Responds with the supported firmware and driver versions. The API doesn't expect firmware and driver versions to be passed in the request and ignores if passed.\n* `CheckCompatibility` - Checks the compatibility for the given firmware and driver versions. This request type expects the firmware and driver versions to filled and the service validates the values and responds back with the error codes.\n* `GetRecommendedDrivers` - Responds with the supported drivers. The API expects firmware version to be filled. The API populates driver ISO url for the given server model. Today the link is same for all servers managed by UCSM whereas it depends on the model for Standalone servers.", "type": "string", "enum": [ "FillSupportedVersions", "CheckCompatibility", "GetRecommendedDrivers" ], "default": "FillSupportedVersions", "x-omitempty": true } } } ] }, "hcl.Constraint": { "title": "Hcl:Constraint", "description": "A key value pair, determining a compatibility constraint for the matching version combinations.", "x-allOf-name": "hcl.Constraint", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.Constraint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.Constraint" ], "default": "hcl.Constraint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.Constraint" ], "default": "hcl.Constraint", "x-enum-as-string": true }, "ConstraintName": { "description": "Name or key of the applicable compatibility constraint.", "type": "string", "x-omitempty": true }, "ConstraintValue": { "description": "Value of the applicable compatibility constraint. Could either be a string value or a regex.", "type": "string", "x-omitempty": true } } } ] }, "hcl.DataImportLog.Response": { "description": "The response body of a HTTP GET request for the 'hcl.DataImportLog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.DataImportLog' resources.", "x-one-of-name": "hcl.DataImportLog.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.DataImportLog.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.DataImportLog": { "title": "Hcl:Data Import Log", "description": "The DataImportLog object serves as a record-keeping tool for tracking the data import processes from the HCL tool. This provides transparency and accountability in the data import workflow, enabling system administrators to monitor and manage data updates effectively.\n#### Purpose\nDataImportLog is essential for documenting the data import operations within the system. It offers detailed insights into the import process, helping administrators ensure data accuracy and consistency across the platform.\n####Key Concepts\n- **Process Tracking:** Logs the details of each data import operation, providing a historical record for audit and review purposes.\n- **Status Documentation:** Captures the status and progress of data imports, enabling administrators to track and respond to any issues that arise.\n- **Administrative Access:** Access is limited to system administrators, ensuring that only authorized personnel can create or read DataImportLog entries.\n- **Relationship Management:** Integrates with account management systems, linking data import activities to specific accounts for enhanced oversight and control.", "x-allOf-name": "hcl.DataImportLog", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.DataImportLog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.DataImportLog" ], "default": "hcl.DataImportLog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.DataImportLog" ], "default": "hcl.DataImportLog", "x-enum-as-string": true }, "CheckSum": { "description": "MD5 Checksum of the HCL Data file.", "type": "string", "x-omitempty": true }, "HclIncrementalData": { "type": "array", "items": { "description": "List of the servers whose data is changed (added/updated/deleted) as per last hcl incremental data import.", "$ref": "#/components/schemas/hcl.ServerConfiguration", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ImportType": { "description": "Type of the import whether it is full or a delta.\n* `Delta` - Imports only changes from the HCL tool into Intersight.\n* `Full` - Deletes the current data and does an full import of the data.", "type": "string", "enum": [ "Delta", "Full" ], "default": "Delta", "x-omitempty": true }, "InitiatorType": { "description": "Type of the initiator whether it is manual or a automated periodic operation by system. The value will be set during DoPost to Manual.\n* `Auto` - Import is auto triggered during service startup or periodic poll.\n* `Manual` - Import is triggered externally by devops using API.", "type": "string", "enum": [ "Auto", "Manual" ], "default": "Auto", "readOnly": true, "x-omitempty": true }, "LastHclDataModifiedTime": { "description": "The timestamp of the last modified record in the HCL tool database. Used to query and get updated records.", "type": "string", "format": "date-time", "x-omitempty": true }, "Status": { "description": "Status of the import process.\n* `None` - Default import status when no activity is taking place with respect to import.\n* `InProgress` - Data import is in progress.\n* `Success` - Data import is successful.\n* `Started` - Data import process has started.\n* `Failed` - Data import process has failed.\n* `NoChange` - There is no change in the data.", "type": "string", "enum": [ "None", "InProgress", "Success", "Started", "Failed", "NoChange" ], "default": "None", "x-omitempty": true }, "StatusDetails": { "description": "More information on the status.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "hcl.DataImportLog.List": { "title": "List of 'hcl.DataImportLog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.DataImportLog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.DataImportLog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.DataImportLog" }, "nullable": true } } } ] }, "hcl.DriverImage.Response": { "description": "The response body of a HTTP GET request for the 'hcl.DriverImage' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.DriverImage' resources.", "x-one-of-name": "hcl.DriverImage.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.DriverImage.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.DriverImage": { "title": "Hcl:Driver Image", "description": "Collection used to store the driver ISO urls for each server based on how it is managed.", "x-allOf-name": "hcl.DriverImage", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.DriverImage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.DriverImage" ], "default": "hcl.DriverImage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.DriverImage" ], "default": "hcl.DriverImage", "x-enum-as-string": true }, "DriverIsoUrl": { "description": "URL of the driver ISO images.", "type": "string", "x-omitempty": true }, "ManagementType": { "description": "Type of the UCS version indicating whether it is a UCSM release vesion or a IMC release.\n* `UCSM` - The server is managed by UCS Manager.\n* `IMC` - The server is standalone managed by CIMC.\n* `IMM` - The server is standalone managed by Intersight.", "type": "string", "enum": [ "UCSM", "IMC", "IMM" ], "default": "UCSM", "x-omitempty": true }, "ServerPid": { "description": "Three part ID representing the server model as returned by UCSM/CIMC XML APIs.", "type": "string", "x-omitempty": true } } } ] }, "hcl.DriverImage.List": { "title": "List of 'hcl.DriverImage' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.DriverImage' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.DriverImage' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.DriverImage" }, "nullable": true } } } ] }, "hcl.ExemptedCatalog.Response": { "description": "The response body of a HTTP GET request for the 'hcl.ExemptedCatalog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.ExemptedCatalog' resources.", "x-one-of-name": "hcl.ExemptedCatalog.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.ExemptedCatalog.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.ExemptedCatalog": { "title": "Hcl:Exempted Catalog", "description": "Collection used to store exempted products (ie. adapters, storage controllers, etc). These products should be ignored for HCL validation purposes.", "x-allOf-name": "hcl.ExemptedCatalog", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.ExemptedCatalog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.ExemptedCatalog" ], "default": "hcl.ExemptedCatalog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.ExemptedCatalog" ], "default": "hcl.ExemptedCatalog", "x-enum-as-string": true }, "Comments": { "description": "Reason for the exemption.", "type": "string", "x-omitempty": true }, "Name": { "description": "A unique descriptive name of the exemption.", "type": "string", "x-omitempty": true }, "OsVendor": { "description": "Vendor of the Operating System.", "type": "string", "x-omitempty": true }, "OsVersion": { "description": "Version of the Operating system.", "type": "string", "x-omitempty": true }, "Personality": { "description": "It indicates the personality of the sever.", "type": "string", "x-omitempty": true }, "ProcessorName": { "description": "Name of the processor supported for the server.", "type": "string", "x-omitempty": true }, "ProductModels": { "type": "array", "items": { "description": "Models of the product/adapter.", "type": "string", "x-omitempty": true }, "nullable": true }, "ProductType": { "description": "Type of the product/adapter say GPU for graphic cards.\n* `` - Default type of the Product.\n* `Adapter` - Represents network adapter cards.\n* `StorageController` - Represents storage controllers.\n* `GPU` - Represents graphics cards.", "type": "string", "enum": [ "", "Adapter", "StorageController", "GPU" ], "default": "", "x-omitempty": true }, "ServerPid": { "description": "Three part ID representing the server model as returned by UCSM/CIMC XML APIs.", "type": "string", "x-omitempty": true }, "UcsVersion": { "description": "Version of the UCS software.", "type": "string", "x-omitempty": true }, "VersionType": { "description": "Type of the UCS version indicating whether it is a UCSM release vesion or a IMC release.", "type": "string", "x-omitempty": true } } } ] }, "hcl.ExemptedCatalog.List": { "title": "List of 'hcl.ExemptedCatalog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.ExemptedCatalog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.ExemptedCatalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.ExemptedCatalog" }, "nullable": true } } } ] }, "hcl.Firmware": { "title": "Hcl:Firmware", "description": "Model which holds the details of firmware version and driver version.", "x-allOf-name": "hcl.Firmware", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.Firmware', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.Firmware" ], "default": "hcl.Firmware", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.Firmware" ], "default": "hcl.Firmware", "x-enum-as-string": true }, "DriverName": { "description": "Protocol for which the driver is provided. E.g. enic, fnic, lsi_mr3.", "type": "string", "x-omitempty": true }, "DriverVersion": { "description": "Version of the Driver supported.", "type": "string", "x-omitempty": true }, "ErrorCode": { "description": "Error code for the support status.\n* `Success` - The input combination is valid.\n* `Unknown` - Unknown API request to the service.\n* `UnknownServer` - An invalid server model is given API requests or the server model is not present in the HCL database.\n* `InvalidUcsVersion` - UCS Version is not in expected format.\n* `ProcessorNotSupported` - Processor is not supported with the given Server or the Processor does not exist in the HCL database.\n* `OSNotSupported` - OS version is not supported with the given server, processor combination or OS information is not present in the HCL database.\n* `OSUnknown` - OS vendor or version is not known as per the HCL database.\n* `UCSVersionNotSupported` - UCS Version is not supported with the given server, processor and OS combination or the UCS version is not present in the HCL database.\n* `UcsVersionServerOSCombinationNotSupported` - Combination of UCS version, server (model and processor) and os version is not supported.\n* `ProductUnknown` - Product is not known as per the HCL database.\n* `ProductNotSupported` - Product is not supported in the given UCS version, server (model and processor) and operating system version.\n* `DriverNameNotSupported` - Driver protocol or name is not supported for the given product.\n* `FirmwareVersionNotSupported` - Firmware version not supported for the component and the server, operating system combination.\n* `DriverVersionNotSupported` - Driver version not supported for the component and the server, operating system combination.\n* `FirmwareVersionDriverVersionCombinationNotSupported` - Both Firmware and Driver versions are not supported for the component and the server, operating system combination.\n* `FirmwareVersionAndDriverVersionNotSupported` - Firmware and Driver version combination not supported for the component and the server, operating system combination.\n* `FirmwareVersionAndDriverNameNotSupported` - Firmware Version and Driver name or not supported with the component and the server, operating system combination.\n* `InternalError` - API requests to the service have either failed or timed out.\n* `MarshallingError` - Error in JSON marshalling.\n* `Exempted` - An exempted error code means that the product is part of the exempted Catalog and should be ignored for HCL validation purposes.", "type": "string", "enum": [ "Success", "Unknown", "UnknownServer", "InvalidUcsVersion", "ProcessorNotSupported", "OSNotSupported", "OSUnknown", "UCSVersionNotSupported", "UcsVersionServerOSCombinationNotSupported", "ProductUnknown", "ProductNotSupported", "DriverNameNotSupported", "FirmwareVersionNotSupported", "DriverVersionNotSupported", "FirmwareVersionDriverVersionCombinationNotSupported", "FirmwareVersionAndDriverVersionNotSupported", "FirmwareVersionAndDriverNameNotSupported", "InternalError", "MarshallingError", "Exempted" ], "default": "Success", "readOnly": true, "x-omitempty": true }, "FirmwareVersion": { "description": "Firmware version of the product/adapter supported.", "type": "string", "x-omitempty": true }, "Id": { "description": "Identifier of the firmware.", "type": "string", "x-omitempty": true }, "LatestDriver": { "description": "True if the driver is latest recommended driver.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LatestFirmware": { "description": "True if the firmware is latest recommended firmware.", "type": "boolean", "readOnly": true, "x-omitempty": true } } } ] }, "hcl.HardwareCompatibilityProfile": { "title": "Hcl:Hardware Compatibility Profile", "description": "Profile giving server hardware details, OS details and UCS Version details.", "x-allOf-name": "hcl.HardwareCompatibilityProfile", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.HardwareCompatibilityProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.HardwareCompatibilityProfile" ], "default": "hcl.HardwareCompatibilityProfile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.HardwareCompatibilityProfile" ], "default": "hcl.HardwareCompatibilityProfile", "x-enum-as-string": true }, "DriverIsoUrl": { "description": "Url for the ISO with the drivers supported for the server.", "type": "string", "x-omitempty": true }, "ErrorCode": { "description": "Error code indicating the compatibility status.\n* `Success` - The input combination is valid.\n* `Unknown` - Unknown API request to the service.\n* `UnknownServer` - An invalid server model is given API requests or the server model is not present in the HCL database.\n* `InvalidUcsVersion` - UCS Version is not in expected format.\n* `ProcessorNotSupported` - Processor is not supported with the given Server or the Processor does not exist in the HCL database.\n* `OSNotSupported` - OS version is not supported with the given server, processor combination or OS information is not present in the HCL database.\n* `OSUnknown` - OS vendor or version is not known as per the HCL database.\n* `UCSVersionNotSupported` - UCS Version is not supported with the given server, processor and OS combination or the UCS version is not present in the HCL database.\n* `UcsVersionServerOSCombinationNotSupported` - Combination of UCS version, server (model and processor) and os version is not supported.\n* `ProductUnknown` - Product is not known as per the HCL database.\n* `ProductNotSupported` - Product is not supported in the given UCS version, server (model and processor) and operating system version.\n* `DriverNameNotSupported` - Driver protocol or name is not supported for the given product.\n* `FirmwareVersionNotSupported` - Firmware version not supported for the component and the server, operating system combination.\n* `DriverVersionNotSupported` - Driver version not supported for the component and the server, operating system combination.\n* `FirmwareVersionDriverVersionCombinationNotSupported` - Both Firmware and Driver versions are not supported for the component and the server, operating system combination.\n* `FirmwareVersionAndDriverVersionNotSupported` - Firmware and Driver version combination not supported for the component and the server, operating system combination.\n* `FirmwareVersionAndDriverNameNotSupported` - Firmware Version and Driver name or not supported with the component and the server, operating system combination.\n* `InternalError` - API requests to the service have either failed or timed out.\n* `MarshallingError` - Error in JSON marshalling.\n* `Exempted` - An exempted error code means that the product is part of the exempted Catalog and should be ignored for HCL validation purposes.", "type": "string", "enum": [ "Success", "Unknown", "UnknownServer", "InvalidUcsVersion", "ProcessorNotSupported", "OSNotSupported", "OSUnknown", "UCSVersionNotSupported", "UcsVersionServerOSCombinationNotSupported", "ProductUnknown", "ProductNotSupported", "DriverNameNotSupported", "FirmwareVersionNotSupported", "DriverVersionNotSupported", "FirmwareVersionDriverVersionCombinationNotSupported", "FirmwareVersionAndDriverVersionNotSupported", "FirmwareVersionAndDriverNameNotSupported", "InternalError", "MarshallingError", "Exempted" ], "default": "Success", "readOnly": true, "x-omitempty": true }, "Id": { "description": "Identifier of the hardware compatibility profile.", "type": "string", "x-omitempty": true }, "OsVendor": { "description": "Vendor of the Operating System running on the server.", "type": "string", "x-omitempty": true }, "OsVersion": { "description": "Version of the Operating System running on the server.", "type": "string", "x-omitempty": true }, "Personality": { "description": "Personality indicating the personality with the which the sever is used in a Hyperflex environment.", "type": "string", "x-omitempty": true }, "ProcessorModel": { "description": "Model of the processor present in the server.", "type": "string", "x-omitempty": true }, "Products": { "type": "array", "items": { "description": "List of the products (adapters/storage controllers) for which compatibility status needs to be checked.", "$ref": "#/components/schemas/hcl.Product", "x-omitempty": true }, "nullable": true }, "ServerModel": { "description": "Model of the server as returned by UCSM/CIMC XML API.", "type": "string", "x-omitempty": true }, "ServerRevision": { "description": "Revision of the server model.", "type": "string", "x-omitempty": true }, "UcsVersion": { "description": "Version of the UCS software.", "type": "string", "x-omitempty": true }, "VersionType": { "description": "Type of the UCS version indicating whether it is a UCSM release vesion or a IMC release.\n* `UCSM` - The server is managed by UCS Manager.\n* `IMC` - The server is standalone managed by CIMC.\n* `IMM` - The server is standalone managed by Intersight.", "type": "string", "enum": [ "UCSM", "IMC", "IMM" ], "default": "UCSM", "x-omitempty": true } } } ] }, "hcl.HwCatalogInfo.Response": { "description": "The response body of a HTTP GET request for the 'hcl.HwCatalogInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.HwCatalogInfo' resources.", "x-one-of-name": "hcl.HwCatalogInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.HwCatalogInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.HwCatalogInfo.Relationship": { "description": "A relationship to the 'hcl.HwCatalogInfo' resource, or the expanded 'hcl.HwCatalogInfo' resource, or the 'null' value.", "x-one-of-name": "hcl.HwCatalogInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hcl.HwCatalogInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "hcl.HwCatalogInfo": { "title": "Hardware Catalog Information for HyperFlex Data Platform", "description": "Hardware catalog information for HyperFlex Data Platform, required for BOM validation.", "x-allOf-name": "hcl.HwCatalogInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.HwCatalogInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.HwCatalogInfo" ], "default": "hcl.HwCatalogInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.HwCatalogInfo" ], "default": "hcl.HwCatalogInfo", "x-enum-as-string": true }, "ServerModel": { "description": "Server model information for HyperFlex servers.", "type": "string", "x-omitempty": true }, "ServerType": { "description": "Server type of the server hardware. For example, server type AF is for an all-flash server.", "type": "string", "x-omitempty": true }, "ServerHwCatalogInfo": { "description": "An array of relationships to hclServerHwCatalogInfo resources.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.ServerHwCatalogInfo.Relationship" }, "nullable": true } } } ] }, "hcl.HwCatalogInfo.List": { "title": "List of 'hcl.HwCatalogInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.HwCatalogInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.HwCatalogInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.HwCatalogInfo" }, "nullable": true } } } ] }, "hcl.HyperflexSoftwareCompatibilityInfo.Response": { "description": "The response body of a HTTP GET request for the 'hcl.HyperflexSoftwareCompatibilityInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.HyperflexSoftwareCompatibilityInfo' resources.", "x-one-of-name": "hcl.HyperflexSoftwareCompatibilityInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.HyperflexSoftwareCompatibilityInfo.Relationship": { "description": "A relationship to the 'hcl.HyperflexSoftwareCompatibilityInfo' resource, or the expanded 'hcl.HyperflexSoftwareCompatibilityInfo' resource, or the 'null' value.", "x-one-of-name": "hcl.HyperflexSoftwareCompatibilityInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "hcl.HyperflexSoftwareCompatibilityInfo": { "title": "Hyperflex Software Compatibility Information", "description": "Lists software compatibility information between different HperFlex component versions like HyperFlex Data Platform, Hypervisor, Drive Firmware, etc.", "x-allOf-name": "hcl.HyperflexSoftwareCompatibilityInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.HyperflexSoftwareCompatibilityInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.HyperflexSoftwareCompatibilityInfo" ], "default": "hcl.HyperflexSoftwareCompatibilityInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.HyperflexSoftwareCompatibilityInfo" ], "default": "hcl.HyperflexSoftwareCompatibilityInfo", "x-enum-as-string": true }, "Constraints": { "type": "array", "items": { "description": "Constraint for the matching software compatibility info, in case the match is applicable for certain cases only. For example a combination of (HyperFlex Data Platform, serverFw and hypervisor) versions can be applicable only for a HyperFlex Cluster UPGRADE operation, so a constraint of \"supportedOperations=upgrade\" can be added to the matching row.", "$ref": "#/components/schemas/hcl.Constraint", "x-omitempty": true }, "nullable": true }, "HxdpVersion": { "description": "HXDP component software version.", "type": "string", "x-omitempty": true }, "HypervisorType": { "description": "Type fo Hypervisor the HyperFlex components versions are compatible with. For example ESX, Hyperv or KVM.\n* `ESXi` - The hypervisor running on the HyperFlex cluster is a Vmware ESXi hypervisor of any version.\n* `Hyper-V` - The hypervisor running on the HyperFlex cluster is Microsoft Hyper-V.\n* `Unknown` - The hypervisor running on the HyperFlex cluster is not known.", "type": "string", "enum": [ "ESXi", "Hyper-V", "Unknown" ], "default": "ESXi", "x-omitempty": true }, "HypervisorVersion": { "description": "Hypervisor component software version.", "type": "string", "x-omitempty": true }, "IsMgmtBuild": { "description": "Type of the HXDP bundle mgmt or full.", "type": "string", "x-omitempty": true }, "MaxMgmtVersion": { "description": "Maximum supported HyperFlex Data Platform build version.", "type": "string", "x-omitempty": true }, "MinMgmtVersion": { "description": "Minimum supported HyperFlex Data Platform build version.", "type": "string", "x-omitempty": true }, "ServerFwVersion": { "description": "UCS Server Firmware component software version.", "type": "string", "x-omitempty": true }, "AppCatalog": { "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/hyperflex.AppCatalog.Relationship", "description": "A reference to a hyperflexAppCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "hcl.HyperflexSoftwareCompatibilityInfo.List": { "title": "List of 'hcl.HyperflexSoftwareCompatibilityInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.HyperflexSoftwareCompatibilityInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.HyperflexSoftwareCompatibilityInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.HyperflexSoftwareCompatibilityInfo" }, "nullable": true } } } ] }, "hcl.OperatingSystem.Response": { "description": "The response body of a HTTP GET request for the 'hcl.OperatingSystem' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.OperatingSystem' resources.", "x-one-of-name": "hcl.OperatingSystem.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.OperatingSystem.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.OperatingSystem.Relationship": { "description": "A relationship to the 'hcl.OperatingSystem' resource, or the expanded 'hcl.OperatingSystem' resource, or the 'null' value.", "x-one-of-name": "hcl.OperatingSystem.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hcl.OperatingSystem" } ], "discriminator": { "propertyName": "ClassId" } }, "hcl.OperatingSystem": { "title": "Hcl:Operating System", "description": "Collection used to store operating system details.", "x-allOf-name": "hcl.OperatingSystem", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.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": [ "hcl.OperatingSystem" ], "default": "hcl.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": [ "hcl.OperatingSystem" ], "default": "hcl.OperatingSystem", "x-enum-as-string": true }, "Version": { "description": "Version of the Operating System.", "type": "string", "x-omitempty": true }, "Vendor": { "$ref": "#/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." } } } ] }, "hcl.OperatingSystem.List": { "title": "List of 'hcl.OperatingSystem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.OperatingSystem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.OperatingSystem' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.OperatingSystem" }, "nullable": true } } } ] }, "hcl.OperatingSystemVendor.Response": { "description": "The response body of a HTTP GET request for the 'hcl.OperatingSystemVendor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.OperatingSystemVendor' resources.", "x-one-of-name": "hcl.OperatingSystemVendor.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.OperatingSystemVendor.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.OperatingSystemVendor.Relationship": { "description": "A relationship to the 'hcl.OperatingSystemVendor' resource, or the expanded 'hcl.OperatingSystemVendor' resource, or the 'null' value.", "x-one-of-name": "hcl.OperatingSystemVendor.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hcl.OperatingSystemVendor" } ], "discriminator": { "propertyName": "ClassId" } }, "hcl.OperatingSystemVendor": { "title": "Hcl:Operating System Vendor", "description": "Collection used to store operating system vendors details.", "x-allOf-name": "hcl.OperatingSystemVendor", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.OperatingSystemVendor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.OperatingSystemVendor" ], "default": "hcl.OperatingSystemVendor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.OperatingSystemVendor" ], "default": "hcl.OperatingSystemVendor", "x-enum-as-string": true }, "Name": { "description": "Name of the vendor of the operating system.", "type": "string", "x-omitempty": true } } } ] }, "hcl.OperatingSystemVendor.List": { "title": "List of 'hcl.OperatingSystemVendor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.OperatingSystemVendor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.OperatingSystemVendor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.OperatingSystemVendor" }, "nullable": true } } } ] }, "hcl.Product": { "title": "Hcl:Product", "description": "Model giving the details of product.", "x-allOf-name": "hcl.Product", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.Product', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.Product" ], "default": "hcl.Product", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.Product" ], "default": "hcl.Product", "x-enum-as-string": true }, "DriverNames": { "type": "array", "items": { "description": "Supported driver names of the product.", "type": "string", "x-omitempty": true }, "nullable": true }, "ErrorCode": { "description": "Error code indicating the support status.\n* `Success` - The input combination is valid.\n* `Unknown` - Unknown API request to the service.\n* `UnknownServer` - An invalid server model is given API requests or the server model is not present in the HCL database.\n* `InvalidUcsVersion` - UCS Version is not in expected format.\n* `ProcessorNotSupported` - Processor is not supported with the given Server or the Processor does not exist in the HCL database.\n* `OSNotSupported` - OS version is not supported with the given server, processor combination or OS information is not present in the HCL database.\n* `OSUnknown` - OS vendor or version is not known as per the HCL database.\n* `UCSVersionNotSupported` - UCS Version is not supported with the given server, processor and OS combination or the UCS version is not present in the HCL database.\n* `UcsVersionServerOSCombinationNotSupported` - Combination of UCS version, server (model and processor) and os version is not supported.\n* `ProductUnknown` - Product is not known as per the HCL database.\n* `ProductNotSupported` - Product is not supported in the given UCS version, server (model and processor) and operating system version.\n* `DriverNameNotSupported` - Driver protocol or name is not supported for the given product.\n* `FirmwareVersionNotSupported` - Firmware version not supported for the component and the server, operating system combination.\n* `DriverVersionNotSupported` - Driver version not supported for the component and the server, operating system combination.\n* `FirmwareVersionDriverVersionCombinationNotSupported` - Both Firmware and Driver versions are not supported for the component and the server, operating system combination.\n* `FirmwareVersionAndDriverVersionNotSupported` - Firmware and Driver version combination not supported for the component and the server, operating system combination.\n* `FirmwareVersionAndDriverNameNotSupported` - Firmware Version and Driver name or not supported with the component and the server, operating system combination.\n* `InternalError` - API requests to the service have either failed or timed out.\n* `MarshallingError` - Error in JSON marshalling.\n* `Exempted` - An exempted error code means that the product is part of the exempted Catalog and should be ignored for HCL validation purposes.", "type": "string", "enum": [ "Success", "Unknown", "UnknownServer", "InvalidUcsVersion", "ProcessorNotSupported", "OSNotSupported", "OSUnknown", "UCSVersionNotSupported", "UcsVersionServerOSCombinationNotSupported", "ProductUnknown", "ProductNotSupported", "DriverNameNotSupported", "FirmwareVersionNotSupported", "DriverVersionNotSupported", "FirmwareVersionDriverVersionCombinationNotSupported", "FirmwareVersionAndDriverVersionNotSupported", "FirmwareVersionAndDriverNameNotSupported", "InternalError", "MarshallingError", "Exempted" ], "default": "Success", "readOnly": true, "x-omitempty": true }, "Firmwares": { "type": "array", "items": { "description": "Supported firmwares list of the product.", "$ref": "#/components/schemas/hcl.Firmware", "x-omitempty": true }, "nullable": true }, "Id": { "description": "Identifier of the product.", "type": "string", "x-omitempty": true }, "Model": { "description": "Model/PID of the product/adapter.", "type": "string", "x-omitempty": true }, "Revision": { "description": "Revision of the adapter model.", "type": "string", "x-omitempty": true }, "Type": { "description": "Type of the product/adapter say OCP, PT, GPU.\n* `` - Default type of the Product.\n* `Adapter` - Represents network adapter cards.\n* `StorageController` - Represents storage controllers.\n* `GPU` - Represents graphics cards.", "type": "string", "enum": [ "", "Adapter", "StorageController", "GPU" ], "default": "", "x-omitempty": true }, "Vendor": { "description": "Vendor of the product or adapter.", "type": "string", "x-omitempty": true } } } ] }, "hcl.ServerCatalog.Response": { "description": "The response body of a HTTP GET request for the 'hcl.ServerCatalog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.ServerCatalog' resources.", "x-one-of-name": "hcl.ServerCatalog.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.ServerCatalog.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.ServerCatalog": { "title": "Hcl:Server Catalog", "description": "Collection used to store the server catalog information. This contails details about all the supported cpu models for the selected Server model.", "x-allOf-name": "hcl.ServerCatalog", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.ServerCatalog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.ServerCatalog" ], "default": "hcl.ServerCatalog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.ServerCatalog" ], "default": "hcl.ServerCatalog", "x-enum-as-string": true }, "ProcessorFamily": { "type": "array", "items": { "description": "List of supported processor family for the server.", "type": "string", "x-omitempty": true }, "nullable": true }, "ServerPid": { "description": "Three part ID representing the server model as returned by UCSM/CIMC XML APIs.", "type": "string", "x-omitempty": true } } } ] }, "hcl.ServerCatalog.List": { "title": "List of 'hcl.ServerCatalog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.ServerCatalog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.ServerCatalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.ServerCatalog" }, "nullable": true } } } ] }, "hcl.ServerConfiguration": { "title": "Hcl:Server Configuration", "description": "Changes to the server configuration that occurred during the most recent incremental import of HCL data.", "x-allOf-name": "hcl.ServerConfiguration", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.ServerConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.ServerConfiguration" ], "default": "hcl.ServerConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.ServerConfiguration" ], "default": "hcl.ServerConfiguration", "x-enum-as-string": true }, "ServerPid": { "description": "Three part ID representing the server model.", "type": "string", "readOnly": true, "x-omitempty": true }, "UcsVersion": { "description": "Version of the UCS software.", "type": "string", "readOnly": true, "x-omitempty": true }, "VersionType": { "description": "Type of the UCS version indicating whether it is a UCSM release vesion or a IMC release.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "hcl.ServerHwCatalogInfo.Response": { "description": "The response body of a HTTP GET request for the 'hcl.ServerHwCatalogInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'hcl.ServerHwCatalogInfo' resources.", "x-one-of-name": "hcl.ServerHwCatalogInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/hcl.ServerHwCatalogInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "hcl.ServerHwCatalogInfo.Relationship": { "description": "A relationship to the 'hcl.ServerHwCatalogInfo' resource, or the expanded 'hcl.ServerHwCatalogInfo' resource, or the 'null' value.", "x-one-of-name": "hcl.ServerHwCatalogInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/hcl.ServerHwCatalogInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "hcl.ServerHwCatalogInfo": { "title": "Hardware Catalog Information for HyperFlex Server", "description": "Server hardware catalog information for a particular server model, used for server BOM validation.", "x-allOf-name": "hcl.ServerHwCatalogInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.ServerHwCatalogInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.ServerHwCatalogInfo" ], "default": "hcl.ServerHwCatalogInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.ServerHwCatalogInfo" ], "default": "hcl.ServerHwCatalogInfo", "x-enum-as-string": true }, "Constraints": { "type": "array", "items": { "description": "Constraint to define if the match is applicable for certain cases only. For example, the maximum number of data disks on a HyperFlex node is different based on the management platform.", "$ref": "#/components/schemas/hcl.Constraint", "x-omitempty": true }, "nullable": true }, "DisplayModel": { "description": "Display model of the server hardware. In many cases, the model string used in the catalog will be the hardware Cisco PID and the Intersight model string is a more user-friendly string with vendor information in it. This will be the user-friendly modal string to be used in Intersight.", "type": "string", "x-omitempty": true }, "Ext_Id": { "description": "Identifier of specific tag.", "type": "string", "x-omitempty": true }, "Model": { "description": "Model of the server hardware from the catalog file.", "type": "string", "x-omitempty": true }, "Type": { "description": "Type of specific tag, required to choose the correct datatype while reading the value.", "type": "string", "x-omitempty": true }, "Value": { "description": "Value of specific tag, having type as json.", "nullable": true, "x-omitempty": true }, "ServerHwInfo": { "description": "An array of relationships to hclServerHwCatalogInfo resources.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.ServerHwCatalogInfo.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "hcl.ServerHwCatalogInfo.List": { "title": "List of 'hcl.ServerHwCatalogInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'hcl.ServerHwCatalogInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'hcl.ServerHwCatalogInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/hcl.ServerHwCatalogInfo" }, "nullable": true } } } ] }, "hcl.SupportedDriverName": { "title": "Hcl:Supported Driver Name", "description": "The SupportedDriverName object facilitates the identification and management of driver names supported for specific products and operating systems. It plays a critical role in ensuring that hardware components operate smoothly with their corresponding software environments.\n#### Purpose\nSupportedDriverName focuses on cataloging driver names compatible with particular products and operating systems. It aids in the deployment and maintenance of system components by providing a reliable reference for supported drivers.\n#### Key Concepts\n- **Driver Identification:** Provides a structured approach to identifying drivers that are compatible with specific products and operating systems, aiding in system setup and maintenance.\n- **Product Association:** Establishes a clear link between products and their supported drivers, ensuring a seamless integration within the system.\n- **API Interaction:** Designed for interaction through API requests, allowing authorized users to access and utilize driver compatibility information effectively.\n- **Entitlement Management:** Governed by entitlements that ensure access is restricted to authorized personnel, maintaining security and operational integrity.", "x-allOf-name": "hcl.SupportedDriverName", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'hcl.SupportedDriverName', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "hcl.SupportedDriverName" ], "default": "hcl.SupportedDriverName", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "hcl.SupportedDriverName" ], "default": "hcl.SupportedDriverName", "x-enum-as-string": true }, "OsVendor": { "description": "Vendor distributing the Operating System.", "type": "string", "x-omitempty": true }, "OsVersion": { "description": "Version of the Operating System.", "type": "string", "x-omitempty": true }, "ProductList": { "type": "array", "items": { "description": "List of Products for which supported driver names is to be filled.", "$ref": "#/components/schemas/hcl.Product", "x-omitempty": true }, "minItems": 1, "nullable": true } } } ] }, "i18n.Message": { "title": "I18n:Message", "description": "An i18n message that can be translated in multiple languages to support internationalization.\nAn i18n message includes a unique message identifier, a text format string, a list of message parameters that can be used \nto substitute parameters, and a translated string based on a user's locale.", "x-allOf-name": "i18n.Message", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'i18n.Message', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "i18n.Message" ], "default": "i18n.Message", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "i18n.Message" ], "default": "i18n.Message", "x-enum-as-string": true }, "Message": { "description": "The default (en-US) localized message. Default localized message will be stored and directly retrieved when\nthe user's locale setting is en-US.", "type": "string", "readOnly": true, "x-omitempty": true }, "MessageId": { "description": "The unique message identitifer used to lookup text templates in a multi-language message catalog.", "type": "string", "readOnly": true, "x-omitempty": true }, "MessageParams": { "type": "array", "items": { "description": "The list of message parameters.", "$ref": "#/components/schemas/i18n.MessageParam", "x-omitempty": true }, "nullable": true } } } ] }, "i18n.MessageParam": { "title": "I18n:Message Param", "description": "A key, value pair used to substitute variables when translating a message in a particular locale for\ninternationalization purpose.", "x-allOf-name": "i18n.MessageParam", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'i18n.MessageParam', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "i18n.MessageParam" ], "default": "i18n.MessageParam", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "i18n.MessageParam" ], "default": "i18n.MessageParam", "x-enum-as-string": true }, "Name": { "description": "The name of a variable which is referenced in a i18n text template.", "type": "string", "readOnly": true, "x-omitempty": true }, "Value": { "description": "The value of a variable which is substituted in a i18n text template.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iam.AbstractClientApplication.Relationship": { "description": "A relationship to the 'iam.AbstractClientApplication' resource, or the expanded 'iam.AbstractClientApplication' resource, or the 'null' value.", "x-one-of-name": "iam.AbstractClientApplication.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.AbstractClientApplication" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.AbstractClientApplication": { "title": "Iam:Abstract Client Application", "description": "Describes an internal application registered against an endpoint in Intersight. The application receives requests specific to \nits use case and these requests require authentication via bearer token validations. The SCIM Client and WebHook Event Receiver Endpoints\nare such examples.", "x-allOf-name": "iam.AbstractClientApplication", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AbstractClientApplication', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "webhook.Endpoint" ], "default": "webhook.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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "webhook.Endpoint" ], "default": "webhook.Endpoint", "x-enum-as-string": true }, "AppCredentials": { "description": "Stores the credentials for the specified authentication type.", "$ref": "#/components/schemas/iam.AppCredentials", "x-createOnly": true, "x-omitempty": true }, "AuthType": { "description": "Type of authentication used by the clientApp.\n* `basic` - The client uses basic username/password authentication. The password is expected to be a JWT token.\n* `none` - No authentication method specified by the client.\n* `bearer-token` - The client uses a long-lived bearer token to authenticate.\n* `auth-code` - The client uses OAuth Authorization Grant Flow without PKCE for authentication.\n* `client-credentials` - The client uses OAuth Client Credentials Flow for authentication.", "type": "string", "enum": [ "basic", "none", "bearer-token", "auth-code", "client-credentials" ], "default": "basic", "x-createOnly": true, "x-omitempty": true }, "CredentialsAction": { "description": "An action to be performed on the credentials.\n* `none` - No action to be performed.\n* `regenerateCredentials` - Allows for revocation and regeneration of a token. The old token associated with the client application. will not be usable and a new token will be generated.", "type": "string", "enum": [ "none", "regenerateCredentials" ], "default": "none", "x-omitempty": true }, "AppRegistration": { "$ref": "#/components/schemas/iam.AppRegistration.Relationship", "description": "A reference to a iamAppRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.AbstractQualifier.Relationship": { "description": "A relationship to the 'iam.AbstractQualifier' resource, or the expanded 'iam.AbstractQualifier' resource, or the 'null' value.", "x-one-of-name": "iam.AbstractQualifier.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.AbstractQualifier" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.AbstractQualifier": { "title": "Iam:Abstract Qualifier", "description": "Placeholder for different types of qualifiers.", "x-allOf-name": "iam.AbstractQualifier", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AbstractQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "iam.Qualifier", "iam.UserQualifier" ], "x-enum-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": [ "iam.Qualifier", "iam.UserQualifier" ], "x-enum-as-string": true }, "Usergroup": { "$ref": "#/components/schemas/iam.UserGroup.Relationship", "description": "A reference to a iamUserGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.Account.Response": { "description": "The response body of a HTTP GET request for the 'iam.Account' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Account' resources.", "x-one-of-name": "iam.Account.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Account.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Account.Relationship": { "description": "A relationship to the 'iam.Account' resource, or the expanded 'iam.Account' resource, or the 'null' value.", "x-one-of-name": "iam.Account.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Account" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Account": { "title": "Iam:Account", "description": "The Account object defines the organizational framework within which users and resources are managed, serving as the central hub for access and permissions.\n#### Purpose\nAn Account encapsulates the structure and permissions associated with a specific organizational unit, providing a secure environment for managing users and resources.\n#### Key Concepts\n- **Access Management:** Governs user access and permissions, ensuring appropriate roles are assigned to users within the account.\n- **Resource Organization:** Structures resources under the account, facilitating management and oversight of assets.\n- **Security Configuration:** Enforces security policies and configurations, including IP access management and session limits.\n- **Identity Providers:** Integrates with identity providers to streamline authentication and user management, enhancing security and user experience.", "x-allOf-name": "iam.Account", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Account', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Account" ], "default": "iam.Account", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Account" ], "default": "iam.Account", "x-enum-as-string": true }, "ExternalIdentifier": { "description": "External identifier for the account, used for integration with external identity systems.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the Intersight account. By default, name is same as the MoID of the account.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]$", "x-omitempty": true }, "Regions": { "type": "array", "items": { "description": "Captures the regions where account is present. For now, account can be present in only one region.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SingleAdminLockout": { "description": "Indicates if the account is prone to lockout as it has only a single Account Administrator. \nAn account is prone to lockout if it has only one configured Account Administrator and no user groups configured that \ncan grant Account Administrator role to dynamic users.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the account. To activate the Intersight account, claim a device to the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "AppRegistrations": { "description": "An array of relationships to iamAppRegistration resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.AppRegistration.Relationship" }, "nullable": true, "readOnly": true }, "DomainGroups": { "description": "An array of relationships to iamDomainGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.DomainGroup.Relationship" }, "nullable": true, "readOnly": true }, "EndPointRoles": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "Idpreferences": { "description": "An array of relationships to iamIdpReference resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IdpReference.Relationship" }, "nullable": true, "readOnly": true }, "Idps": { "description": "An array of relationships to iamIdp resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Idp.Relationship" }, "nullable": true, "readOnly": true }, "Permissions": { "description": "An array of relationships to iamPermission resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Permission.Relationship" }, "nullable": true, "readOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true, "readOnly": true }, "Privileges": { "description": "An array of relationships to iamPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Privilege.Relationship" }, "nullable": true, "readOnly": true }, "ResourceLimits": { "$ref": "#/components/schemas/iam.ResourceLimits.Relationship", "description": "A reference to a iamResourceLimits resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Roles": { "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true, "readOnly": true }, "SecurityHolder": { "$ref": "#/components/schemas/iam.SecurityHolder.Relationship", "description": "A reference to a iamSecurityHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SessionLimits": { "$ref": "#/components/schemas/iam.SessionLimits.Relationship", "description": "A reference to a iamSessionLimits resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.Account.List": { "title": "List of 'iam.Account' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Account' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Account' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Account" }, "nullable": true } } } ] }, "iam.AccountExperience.Response": { "description": "The response body of a HTTP GET request for the 'iam.AccountExperience' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.AccountExperience' resources.", "x-one-of-name": "iam.AccountExperience.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.AccountExperience.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.AccountExperience": { "title": "Iam:Account Experience", "description": "AccountExperience captures the set of beta or preview features enabled for a specific account.\n#### Purpose\nIt allows controlled enablement of new capabilities for evaluation and phased rollout.\n#### Key Concepts\n- **Feature Flags:** Represents toggles for account-specific experiences.\n- **Marketing and OPS Control:** Managed by authorized internal roles.\n- **Shared Scope:** Visible across organizations where applicable.\n- **Rollout Safety:** Enables granular, account-level previews.", "x-allOf-name": "iam.AccountExperience", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountExperience', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AccountExperience" ], "default": "iam.AccountExperience", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AccountExperience" ], "default": "iam.AccountExperience", "x-enum-as-string": true }, "Features": { "type": "array", "items": { "description": "The list of enabled beta features for the account.", "$ref": "#/components/schemas/iam.FeatureDefinition", "x-omitempty": true }, "nullable": true }, "Account": { "$ref": "#/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." } } } ] }, "iam.AccountExperience.List": { "title": "List of 'iam.AccountExperience' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.AccountExperience' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.AccountExperience' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.AccountExperience" }, "nullable": true } } } ] }, "iam.AccountPermissions": { "title": "Iam:Account Permissions", "description": "Users can log in through the base URL (https://intersight.com) or account-specific URLs. When the Intersight user logs in through the base URL, Intersight identifies the accounts and permissions within each account which the user has access to. In case multiple permissions are identified, the user and session objects are created in the onboarding-user account, and the session object is updated with account and permission information. Intersight GUI uses this information to show available accounts and permissions for the user to select.", "x-allOf-name": "iam.AccountPermissions", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountPermissions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AccountPermissions" ], "default": "iam.AccountPermissions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AccountPermissions" ], "default": "iam.AccountPermissions", "x-enum-as-string": true }, "AccountIdentifier": { "description": "MOID of the account which a user can select after authentication.", "type": "string", "readOnly": true, "x-omitempty": true }, "AccountName": { "description": "Name of the account which a user can select after authentication.", "type": "string", "readOnly": true, "x-omitempty": true }, "AccountPermissionTags": { "type": "array", "items": { "description": "The array of tags on account permission object.", "$ref": "#/components/schemas/iam.AccountTags", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AccountStatus": { "description": "Status of the account. Account remains inactive until a device is claimed to the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "HomeRegion": { "description": "Region where account belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "Permissions": { "type": "array", "items": { "description": "Permissions within an account which a user can select after authentication.", "$ref": "#/components/schemas/iam.PermissionReference", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.AccountTags": { "title": "Iam:Account Tags", "description": "An arbitrary key and value pair that can be used to tag REST resources and organize managed objects by\nassigning meta-data tags to any object.", "x-allOf-name": "iam.AccountTags", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountTags', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AccountTags" ], "default": "iam.AccountTags", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AccountTags" ], "default": "iam.AccountTags", "x-enum-as-string": true }, "Key": { "description": "The string representation of a tag key.", "type": "string", "x-omitempty": true }, "Value": { "description": "The string representation of a tag value.", "type": "string", "x-omitempty": true } } } ] }, "iam.AccountTypeBase": { "title": "Iam:Account Type Base", "description": "Base type for all user account types in the endpoint user management system. It defines the shared structure and properties that are common to all account types, such as the account type name.\nServing as the foundation for more specific account types, including Local and IPMI, AccountTypeBase enables consistent modeling, validation, and extension of user account types. This approach ensures flexibility and maintainability as new account types are introduced.", "x-allOf-name": "iam.AccountTypeBase", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountTypeBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "iam.AccountTypeIpmi", "iam.AccountTypeLocal" ], "x-enum-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": [ "iam.AccountTypeIpmi", "iam.AccountTypeLocal" ], "x-enum-as-string": true }, "Name": { "description": "Name of the Account type such as Local or IPMI, that identifies the kind of user account.", "type": "string", "x-omitempty": true } } } ] }, "iam.AccountTypeIpmi": { "title": "IPMI", "description": "Account type for creating IPMI user on the endpoint. IPMI user enables IPMI User on the endpoint.", "x-allOf-name": "iam.AccountTypeIpmi", "allOf": [ { "$ref": "#/components/schemas/iam.AccountTypeBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AccountTypeIpmi', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AccountTypeIpmi" ], "default": "iam.AccountTypeIpmi", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AccountTypeIpmi" ], "default": "iam.AccountTypeIpmi", "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 must have a minimum of 8 and a maximum of 127 characters. For servers with IPMI user role enabled, the maximum length is limited to 20 characters. When strong password is enabled, must satisfy below requirements: A. The password must not contain the User's Name. B. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, #, $, %, ^, &, *, -, _, +, =).", "type": "string", "pattern": "^$|^[a-zA-Z0-9!@#$%^&\\*+-_=]+$", "minLength": 8, "maxLength": 20, "writeOnly": true, "x-omitempty": true }, "UseDiffIpmiPassword": { "description": "Use Different IPMI Password. If false then same Local User Password will be used for IPMI.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "iam.AccountTypeLocal": { "title": "Local", "description": "Account type for creating local user on the endpoint. Local user enables Redfish User on the endpoint.", "x-allOf-name": "iam.AccountTypeLocal", "allOf": [ { "$ref": "#/components/schemas/iam.AccountTypeBase" } ] }, "iam.ApiKey.Response": { "description": "The response body of a HTTP GET request for the 'iam.ApiKey' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ApiKey' resources.", "x-one-of-name": "iam.ApiKey.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ApiKey.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ApiKey.Relationship": { "description": "A relationship to the 'iam.ApiKey' resource, or the expanded 'iam.ApiKey' resource, or the 'null' value.", "x-one-of-name": "iam.ApiKey.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ApiKey" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ApiKey": { "title": "Iam:Api Key", "description": "The ApiKey object is a critical component for secure authentication and authorization within the system. It allows clients to make API requests programmatically using a secure HTTP signature scheme.\n#### Purpose\nAn ApiKey serves as a mechanism for authentication and authorization, enabling unattended clients, such as daemons, to interact with the API securely. This provides the means to verify the identity of a client and ensure they have the appropriate permissions to perform specific actions.\n#### Key Concepts\n- **Public Key Cryptography:** Utilizes public key cryptography to ensure secure authentication, with the server holding the public key and the client maintaining the confidentiality of the private key.\n- **Request Signing:** Involves signing HTTP requests to ensure integrity and authenticity, using cryptographic digest and signature mechanisms.\n- **Access Control:** Restricted to specific privilege sets, ensuring only authorized users can create, read, update, or delete API keys.\n- **Expiration and Rotation:** Supports expiration settings and key rotation, enhancing security by limiting the validity period of keys and facilitating the replacement of compromised or expired keys.", "x-allOf-name": "iam.ApiKey", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ApiKey', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ApiKey" ], "default": "iam.ApiKey", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ApiKey" ], "default": "iam.ApiKey", "x-enum-as-string": true }, "AdminStatus": { "description": "Used to trigger the enable or disable action on the API key. These actions change the status of an API key.\n* `enable` - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.\n* `disable` - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.", "type": "string", "enum": [ "enable", "disable" ], "default": "enable", "x-omitempty": true }, "ExpiryDateTime": { "description": "The expiration date of the API key which is set at the time of creation of the key. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the API key to the maximum expiry time configured at the account level.", "type": "string", "format": "date-time", "x-omitempty": true }, "HashAlgorithm": { "description": "The cryptographic hash algorithm to calculate the message digest.\n* `SHA256` - The SHA-256 cryptographic hash, as defined by NIST in FIPS 180-4.\n* `SHA384` - The SHA-384 cryptographic hash, as defined by NIST in FIPS 180-4.\n* `SHA512` - The SHA-512 cryptographic hash, as defined by NIST in FIPS 180-4.\n* `SHA512_224` - The SHA-512/224 cryptographic hash, as defined by NIST in FIPS 180-4.\n* `SHA512_256` - The SHA-512/256 cryptographic hash, as defined by NIST in FIPS 180-4.", "type": "string", "enum": [ "SHA256", "SHA384", "SHA512", "SHA512_224", "SHA512_256" ], "default": "SHA256", "x-createOnly": true, "x-omitempty": true }, "IsNeverExpiring": { "description": "Used to mark the API key as a never-expiring API key.", "type": "boolean", "default": false, "x-omitempty": true }, "KeySpec": { "description": "The key generation specification provides the algorithm and the parameters required for this algorithm to generate a private key, public key pair. Supported key generation schemes include RSA, ECDSA and Edwards-Curve Digital Signature Algorithm (EdDSA).", "$ref": "#/components/schemas/pkix.KeyGenerationSpec", "x-createOnly": true, "x-omitempty": true }, "LastUsedIp": { "description": "The IP address from which the API key was last used.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastUsedTime": { "description": "The time at which the API key was last used. It is updated every 24 hours.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "OperStatus": { "description": "The current status of the API key that dictates the validity of the key.\n* `enabled` - An API key/App Registration having enabled status can be used for API invocation.\n* `disabled` - An API key/App Registration having disabled status cannot be used for API invocation.\n* `expired` - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.", "type": "string", "enum": [ "enabled", "disabled", "expired" ], "default": "enabled", "readOnly": true, "x-omitempty": true }, "PrivateKey": { "description": "Holds the private key for the API key.", "type": "string", "x-omitempty": true }, "Purpose": { "description": "The purpose of the API Key.", "type": "string", "maxLength": 1024, "x-omitempty": true }, "Scope": { "description": "Scope holds a collection of account Id, permission Id to which the current session is scoped to.", "$ref": "#/components/schemas/iam.SwitchScopePermissions", "readOnly": true, "x-omitempty": true }, "SigningAlgorithm": { "description": "The signing algorithm used by the client to authenticate API requests to Intersight.\nThe signing algorithm must be compatible with the key generation specification.\n* `RSASSA-PKCS1-v1_5` - RSASSA-PKCS1-v1_5 is a RSA signature scheme specified in [RFC 8017](https://tools.ietf.org/html/rfc8017).RSASSA-PKCS1-v1_5 is included only for compatibility with existing applications.\n* `RSASSA-PSS` - RSASSA-PSS is a RSA signature scheme specified in [RFC 8017](https://tools.ietf.org/html/rfc8017).It combines the RSASP1 and RSAVP1 primitives with the EMSA-PSS encoding method.In the interest of increased robustness, RSASSA-PSS is required in new applications.\n* `Ed25519` - The Ed25519 signature algorithm, as specified in [RFC 8032](https://tools.ietf.org/html/rfc8032).Ed25519 is a public-key signature system with several attractive features, includingfast single-signature verification, very fast signing, fast key generation and high security level.\n* `Ecdsa` - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is encoded as a ASN.1 DER SEQUENCE with two INTEGERs (r and s), as defined in RFC3279.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.\n* `EcdsaP1363Format` - The Elliptic Curve Digital Signature Standard (ECDSA), as defined by NIST in FIPS 186-4 and ANSI X9.62.The signature is the raw concatenation of r and s, as defined in the ISO/IEC 7816-8 IEEE P.1363 standard.In that format, r and s are represented as unsigned, big endian numbers.Extra padding bytes (of value 0x00) is applied so that both r and s encodings have the same size.When using ECDSA signatures, configure the client to use the same signature encoding as specified on the server side.", "type": "string", "enum": [ "RSASSA-PKCS1-v1_5", "RSASSA-PSS", "Ed25519", "Ecdsa", "EcdsaP1363Format" ], "default": "RSASSA-PKCS1-v1_5", "x-createOnly": true, "x-omitempty": true }, "StartTime": { "description": "The timestamp at which an expiry date was first set on this API key. For expiring API keys, this field is same as the create time of the API key. For never-expiring API keys, this field is set initially to zero time value. If a never-expiry API key is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/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 } } } ] }, "iam.ApiKey.List": { "title": "List of 'iam.ApiKey' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ApiKey' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ApiKey' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ApiKey" }, "nullable": true } } } ] }, "iam.AppCredentials": { "title": "Iam:App Credentials", "description": "Contains credentials information for a particular client application.", "x-allOf-name": "iam.AppCredentials", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "iam.AppRegistration.Response": { "description": "The response body of a HTTP GET request for the 'iam.AppRegistration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.AppRegistration' resources.", "x-one-of-name": "iam.AppRegistration.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.AppRegistration.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.AppRegistration.Relationship": { "description": "A relationship to the 'iam.AppRegistration' resource, or the expanded 'iam.AppRegistration' resource, or the 'null' value.", "x-one-of-name": "iam.AppRegistration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.AppRegistration" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.AppRegistration": { "title": "App Registration", "description": "The AppRegistration object facilitates the registration of OAuth2 client applications, enabling secure access to APIs using OAuth2 credentials.\n#### Purpose\nAn AppRegistration defines the metadata and configuration required for OAuth2 client applications to authenticate and obtain access tokens. The metadata defines how a client application retrieves an OAuth2 access token and uses it to invoke the Intersight API on behalf of the AppRegistration. It ensures a secure and controlled mechanism for applications to interact with the system.\n#### Key Concepts\n- **OAuth2 Compliance:** Adheres to OAuth2 standards, supporting various grant types and response types for secure API access.\n- **Client Identification:** Provides unique client IDs and secrets for registered applications, ensuring each client is identifiable and secure.\n- **Redirect URIs:** Specifies the redirection endpoints for OAuth2 flows, ensuring the safe transfer of authorization codes or tokens.\n- **Token Management:** Includes mechanisms for token expiration, revocation, and renewal, maintaining security by managing the lifecycle of access tokens.", "x-allOf-name": "iam.AppRegistration", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.AppRegistration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.AppRegistration" ], "default": "iam.AppRegistration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.AppRegistration" ], "default": "iam.AppRegistration", "x-enum-as-string": true }, "AdminStatus": { "description": "Used to trigger the enable or disable action on the App Registration. These actions change the status of an App Registration.\n* `enable` - Used to enable a disabled API key/App Registration. If the API key/App Registration is already expired, this action has no effect.\n* `disable` - Used to disable an active API key/App Registration. If the API key/App Registration is already expired, this action has no effect.", "type": "string", "enum": [ "enable", "disable" ], "default": "enable", "x-omitempty": true }, "ClientId": { "description": "A unique identifier for the OAuth2 client application.\nThe client ID is auto-generated when the AppRegistration object is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClientName": { "description": "App Registration name specified by user.", "type": "string", "x-omitempty": true }, "ClientSecret": { "description": "The OAuth2 client secret.\nThe value of this property is generated when grantType includes 'client-credentials'.\nOtherwise, no client-secret is generated.", "type": "string", "x-omitempty": true }, "ClientType": { "description": "The type of the OAuth2 client (public or confidential), as specified in https://tools.ietf.org/html/rfc6749#section-2.1.\n* `public` - Clients incapable of maintaining the confidentiality of their credentials.This includes clients executing on the device used by the resource owner,such as mobile applications, installed native application or a webbrowser-based application.\n* `confidential` - Clients capable of maintaining the confidentiality of their credentials.For example, this could be a client implemented on a secure server withrestricted access to the client credentials.To maintain the confidentiality of the OAuth2 credentials, two use cases areconsidered.1) The application is running as a service within Intersight. The application automatically obtains the OAuth2 credentials when the application starts and the credentials are not exposed to the end-user. Because end-users (even account administrators) do not have access the OAuth2 credentials, they cannot take the credentials with them when they leave their organization.2) The application is under the control of a \"trusted\" end-user. For example, the end-user may create a native application running outside Intersight. The application uses OAuth2 credentials to interact with the Intersight API. In that case, the Intersight account administrator may generate OAuth2 credentials with a registered application using \"client_credentials\" grant type. In that case, the end-user is responsible for maintaining the confidentiality of the OAuth2 credentials. If the end-user leaves the organization, you should revoke the credentials and issue new Oauth2 credentials.Here is a possible workflow for handling OAuth2 tokens.1) User Alice (Intersight Account Administrator) logins to Intersight and deploys an Intersight application that requires an OAuth2 token.2) Intersight automatically deploys the application. The application is assigned a OAuth2 token, possibly linked to Alice. The application must NOT expose the OAuth2 secret to Alice, otherwise Alice would be able to use the token after she leaves the company.3) The application can make API calls to Intersight using its assigned OAuth2 token. For example, the application could make weekly scheduled API calls to Intersight.4) Separately, Alice may also get OAuth2 tokens that she can use to make API calls from the Intersight SDK through the northbound API. In that case, Alice will get the associated OAuth2 secrets, but not the one assigned in step #2.5) Alice leaves the organization. The OAuth2 tokens assigned in step #2 must retain their validity even after Alice has left the organization. Because the OAuth2 secrets were never shared with Alice, there is no risk Alice can reuse the OAuth2 secrets. On the other hand, the OAuth2 tokens assigned in step #4 must be invalidated because Alice had the OAuth2 tokens in her possession.", "type": "string", "enum": [ "public", "confidential" ], "default": "public", "x-omitempty": true }, "Description": { "description": "Description of the application.", "type": "string", "x-omitempty": true }, "EntityId": { "description": "EntityId holds the Id of the client application that is using this AppRegistration.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExpiryDateTime": { "description": "The expiration date of the App Registration which is set at the time of its creation. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured at the account level. The expiry date can be edited to be earlier or later, provided it stays within the designated expiry period. This period is determined by adding the 'startTime' property of the App Registration to the maximum expiry time configured at the account level.", "type": "string", "format": "date-time", "x-omitempty": true }, "GrantTypes": { "type": "array", "items": { "description": "The set of grant types that OAuth2 clients can use for this application.\nThe grant type is used in the OAuth2 login flow to validate the grant type that has been requested by the client.\nSee https://tools.ietf.org/html/rfc7591#page-9 for more details.\n# It is set automatically when AppRegistration is created since currently we do not provide option for the user.\n* `authorization_code` - The 'authorization code' grant type as defined in the OAuth2 specification.It implies a \"response_types\" value that includes \"code\".\n* `refresh_token` - The 'refresh token' grant type defined in the OAuth2 specification.https://tools.ietf.org/html/rfc7591#section-6.\n* `client_credentials` - The 'client credentials' grant type defined in the OAuth2 specification.A client can request an access token using only its clientcredentials (or other supported means of authentication) when theclient is requesting access to the protected resources under itscontrol, or those of another resource owner that have been previouslyarranged with the authorization server.https://tools.ietf.org/html/rfc6749#section-4.4.\n* `implicit` - The implicit grant is a simplified authorization code flow optimizedfor clients implemented in a browser using a scripting language suchas JavaScript. In the implicit flow, instead of issuing the clientan authorization code, the client is issued an access token directly(as the result of the resource owner authorization). The grant typeis implicit, as no intermediate credentials (such as an authorizationcode) are issued (and later used to obtain an access token).When issuing an access token during the implicit grant flow, theauthorization server does not authenticate the client. In somecases, the client identity can be verified via the redirection URIused to deliver the access token to the client. The access token maybe exposed to the resource owner or other applications with access tothe resource owner's user-agent.\n* `password` - The resource owner password credentials (i.e., username and password)can be used directly as an authorization grant to obtain an accesstoken. The credentials should only be used when there is a highdegree of trust between the resource owner and the client (e.g., theclient is part of the device operating system or a highly privilegedapplication), and when other authorization grant types are notavailable (such as an authorization code).\n* `urn:ietf:params:oauth:grant-type:jwt-bearer` - The JWT Bearer Token Grant Type defined in OAuth JWT Bearer Token Profiles [RFC7523].\n* `urn:ietf:params:oauth:grant-type:saml2-bearer` - The SAML 2.0 Bearer Assertion Grant defined in OAuth SAML 2 Bearer Token Profiles [RFC7522].", "type": "string", "enum": [ "authorization_code", "refresh_token", "client_credentials", "implicit", "password", "urn:ietf:params:oauth:grant-type:jwt-bearer", "urn:ietf:params:oauth:grant-type:saml2-bearer" ], "default": "authorization_code", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsNeverExpiring": { "description": "Used to mark the App Registration as a never-expiring App Registration.", "type": "boolean", "default": false, "x-omitempty": true }, "LastUsedIp": { "description": "The ip address from which the App Registration was last used.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastUsedTime": { "description": "The time at which the App Registration was last used. It is updated every 24 hours.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "OperStatus": { "description": "The current status of the App Registration that dictates the validity of the app.\n* `enabled` - An API key/App Registration having enabled status can be used for API invocation.\n* `disabled` - An API key/App Registration having disabled status cannot be used for API invocation.\n* `expired` - An API key/App Registration having expired status cannot be used for API invocation as the expiration date has passed.", "type": "string", "enum": [ "enabled", "disabled", "expired" ], "default": "enabled", "readOnly": true, "x-omitempty": true }, "RedirectUris": { "type": "array", "items": { "description": "After a user successfully authorizes an application, the OAuth2 authorization server will redirect the user back to the\napplication with either an authorization code or access token in the URL.\nRegistered redirect URLs may contain query string parameters, but must not contain anything in the fragment.\nThe registration server rejects the request if a user tries to register a redirect URL that contains a fragment.\nFor native and mobile apps, Intersight allows a user to register a URL scheme such as myapp:// which can then be used\nin the redirect URL. The authorization server allows arbitrary URL schemes to be registered in order to support\nregistering redirect URLs for native apps.\nRedirect URLs are a critical part of the OAuth flow. After a user successfully authorizes an application,\nthe authorization server will redirect the user back to the application with either an authorization code or access\ntoken in the URL. Because the redirect URL will contain sensitive information, it is critical that the service\ndoesn\u2019t redirect the user to arbitrary locations.\nThe best way to ensure the user will only be directed to appropriate locations is to require the developer to\nregister one or more redirect URLs when they create the application.\nThe redirection endpoint URI MUST be an absolute URI.", "type": "string", "pattern": "^$|^(?:[\\w.-]+?:\\/\\/)[\\w\\.\\-\\/\\d\\:]+$", "x-omitempty": true }, "nullable": true }, "RenewClientSecret": { "description": "Set value to true to renew the client-secret. Applicable to client_credentials grant type.", "type": "boolean", "default": false, "x-omitempty": true }, "ResponseTypes": { "type": "array", "items": { "description": "The set of response types that a OAuth2 client can use.\nThis is static list and it is set automatically when AppRegistration is created.\nAccording to RFC, it is used in OAuth2 login flow to check that this AppRegistration supports response type from the request.\nSee https://tools.ietf.org/html/rfc7591#page-9 for more details.\n* `code` - The authorization code response type defined in OAuth2, section 4.1.\n* `token` - The token response type defined in OAuth2, section 4.2.", "type": "string", "enum": [ "code", "token" ], "default": "code", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RevocationTimestamp": { "description": "Used to perform revocation for tokens of AppRegistration.\nUpdated only internally is case Revoke property come from UI with value true.\nOn each request with OAuth2 access token the CreationTime of the OAuth2 token will be compared to RevokationTimestamp of the\ncorresponding App Registration.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Revoke": { "description": "Used to trigger update the revocationTimestamp value.\nIf UI sent updating request with the Revoke value is true, then update RevocationTimestamp.", "type": "boolean", "default": false, "x-omitempty": true }, "Scope": { "description": "Scope holds a collection of account Id, permission Id to which the current session is scoped to.", "$ref": "#/components/schemas/iam.SwitchScopePermissions", "readOnly": true, "x-omitempty": true }, "ShowConsentScreen": { "description": "Set to true if consent screen needs to be shown during the OAuth login process.\nApplicable only for public AppRegistrations, means only 'authorization_code' grantType.\nNote that consent screen will be shown on each login.", "type": "boolean", "default": false, "x-omitempty": true }, "StartTime": { "description": "The timestamp at which an expiry date was first set on this app registration. \nFor expiring App Registrations, this field is same as the create time of the App Registration.\nFor never-expiring App Registrations, this field is set initially to zero time value. If a never-expiry App Registration is later changed to have an expiration, the timestamp marking the start of this transition is recorded in this field.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "TokenExpiry": { "description": "Defines the expiry time of the token generated via the AppRegistration.\n* `generic` - This sets the expiryTime to ten minutes from the token issuing time.\n* `longLived` - This sets the expiryTime to an year from the token issuing time.\n* `infinite` - This allows for a never-expiring token. Use with caution.", "type": "string", "enum": [ "generic", "longLived", "infinite" ], "default": "generic", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "ClientApplication": { "$ref": "#/components/schemas/iam.AbstractClientApplication.Relationship", "description": "A reference to a iamAbstractClientApplication resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OauthTokens": { "description": "An array of relationships to iamOAuthToken resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.OAuthToken.Relationship" }, "nullable": true, "readOnly": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Roles": { "deprecated": true, "x-sunset": "2027-03-01", "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true }, "SecurityHolder": { "$ref": "#/components/schemas/iam.SecurityHolder.Relationship", "description": "A reference to a iamSecurityHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/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 } } } ] }, "iam.AppRegistration.List": { "title": "List of 'iam.AppRegistration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.AppRegistration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.AppRegistration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.AppRegistration" }, "nullable": true } } } ] }, "iam.BannerMessage.Response": { "description": "The response body of a HTTP GET request for the 'iam.BannerMessage' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.BannerMessage' resources.", "x-one-of-name": "iam.BannerMessage.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.BannerMessage.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.BannerMessage": { "title": "Iam:Banner Message", "description": "BannerMessage configures a global banner for an account, controlling whether it is displayed and what content it shows.\n#### Purpose\nIt provides a mechanism to communicate important notices or policies to users across the account.\n#### Key Concepts\n- **User Communication:** Surfaces messages consistently in the UI.\n- **Administrative Control:** Managed by account administrators.\n- **Non-intrusive:** Designed for clarity without operational disruption.\n- **Account-wide Scope:** Applies across the account's user base.", "x-allOf-name": "iam.BannerMessage", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.BannerMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.BannerMessage" ], "default": "iam.BannerMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.BannerMessage" ], "default": "iam.BannerMessage", "x-enum-as-string": true }, "BannerContents": { "description": "Contents of the banner message.", "type": "string", "x-omitempty": true }, "BannerDisplay": { "description": "Whether or not to display the banner message.", "type": "boolean", "x-omitempty": true }, "BannerTitle": { "description": "Title of the banner message.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "iam.BannerMessage.List": { "title": "List of 'iam.BannerMessage' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.BannerMessage' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.BannerMessage' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.BannerMessage" }, "nullable": true } } } ] }, "iam.BasicAuthCredentials": { "title": "Iam:Basic Auth Credentials", "description": "Defines a credentials Holder for Basic authentication.", "x-allOf-name": "iam.BasicAuthCredentials", "allOf": [ { "$ref": "#/components/schemas/iam.AppCredentials" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.BasicAuthCredentials', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.BasicAuthCredentials" ], "default": "iam.BasicAuthCredentials", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.BasicAuthCredentials" ], "default": "iam.BasicAuthCredentials", "x-enum-as-string": true }, "Password": { "description": "Contains the password for the basic auth flow.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Username": { "description": "Contains the username for the basic auth flow.", "type": "string", "x-createOnly": true, "x-omitempty": true } } } ] }, "iam.Certificate.Response": { "description": "The response body of a HTTP GET request for the 'iam.Certificate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Certificate' resources.", "x-one-of-name": "iam.Certificate.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Certificate.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Certificate.Relationship": { "description": "A relationship to the 'iam.Certificate' resource, or the expanded 'iam.Certificate' resource, or the 'null' value.", "x-one-of-name": "iam.Certificate.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Certificate" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Certificate": { "title": "Iam:Certificate", "description": "Certificate holds a user-provided certificate (signed by a CA) associated with a previously generated CSR, including validation status.\n#### Purpose\nIt completes the certificate lifecycle by attaching the signed artifact to the originating request.\n#### Key Concepts\n- **CSR Pairing:** Linked to a specific certificate request.\n- **Validation State:** Tracks readiness and correctness of the certificate.\n- **Account Process:** Operates within account certificate workflows.\n- **Trust Enablement:** Supports secure endpoint and service identities.", "x-allOf-name": "iam.Certificate", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Certificate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Certificate" ], "default": "iam.Certificate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Certificate" ], "default": "iam.Certificate", "x-enum-as-string": true }, "Certificate": { "description": "User-input pem-encoded certificate, signed by a CAcert.", "$ref": "#/components/schemas/x509.Certificate", "x-omitempty": true }, "Status": { "description": "Status of the certificate.\n* `PendingValidation` - The certificate has not been validated.\n* `Valid` - The certificate is valid.\n* `Invalid` - Ther certificate is invalid.", "type": "string", "enum": [ "PendingValidation", "Valid", "Invalid" ], "default": "PendingValidation", "readOnly": true, "x-omitempty": true }, "CertificateRequest": { "$ref": "#/components/schemas/iam.CertificateRequest.Relationship", "description": "A reference to a iamCertificateRequest resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.Certificate.List": { "title": "List of 'iam.Certificate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Certificate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Certificate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Certificate" }, "nullable": true } } } ] }, "iam.CertificateRequest.Response": { "description": "The response body of a HTTP GET request for the 'iam.CertificateRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.CertificateRequest' resources.", "x-one-of-name": "iam.CertificateRequest.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.CertificateRequest.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.CertificateRequest.Relationship": { "description": "A relationship to the 'iam.CertificateRequest' resource, or the expanded 'iam.CertificateRequest' resource, or the 'null' value.", "x-one-of-name": "iam.CertificateRequest.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.CertificateRequest" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.CertificateRequest": { "title": "Iam:Certificate Request", "description": "The information required to generate a certificate signing request (CSR),\nwhich is a block of encoded text that is given to a Certificate Authority when applying for an SSL Certificate.", "x-allOf-name": "iam.CertificateRequest", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.CertificateRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.CertificateRequest" ], "default": "iam.CertificateRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.CertificateRequest" ], "default": "iam.CertificateRequest", "x-enum-as-string": true }, "EmailAddress": { "description": "User input email address, an optional part of the subject of the certificate request.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the certificate request.", "type": "string", "pattern": "^$|^[A-Za-z0-9]([^/\\\\.]*(\\.[^/\\\\.]+)*)?$", "x-createOnly": true, "x-omitempty": true }, "Request": { "description": "Generated certificate signing request (CSR) in PEM format.", "type": "string", "readOnly": true, "x-omitempty": true }, "SelfSigned": { "description": "Whether the user wants the generated CSR to be self-signed by the appliance.", "type": "boolean", "x-omitempty": true }, "Subject": { "description": "The x.509 distinguished name of the subject of the certificate request.", "$ref": "#/components/schemas/pkix.DistinguishedName", "x-omitempty": true }, "SubjectAlternateName": { "description": "The x.509 subject alternate name values of the certificate request.", "$ref": "#/components/schemas/pkix.SubjectAlternateName", "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Certificate": { "$ref": "#/components/schemas/iam.Certificate.Relationship", "description": "A reference to a iamCertificate resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PrivateKeySpec": { "$ref": "#/components/schemas/iam.PrivateKeySpec.Relationship", "description": "A reference to a iamPrivateKeySpec resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.CertificateRequest.List": { "title": "List of 'iam.CertificateRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.CertificateRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.CertificateRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.CertificateRequest" }, "nullable": true } } } ] }, "iam.ClientMeta": { "title": "Iam:Client Meta", "description": "Contains meta information of the client. Currently it is used only within OAuth clients.", "x-allOf-name": "iam.ClientMeta", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ClientMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ClientMeta" ], "default": "iam.ClientMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ClientMeta" ], "default": "iam.ClientMeta", "x-enum-as-string": true }, "DeviceModel": { "description": "Parsed device model from raw User-Agent.", "type": "string", "x-omitempty": true }, "UserAgent": { "description": "The value of the \"User-Agent\" HTTP header, as sent by the HTTP client when it initiate a session to Intersight. This can be used to identify the client operating system, browser type and browser version.\nExample - Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36\nIt is set when User successfully passed OAuth login flow and receives Access Token.", "type": "string", "x-omitempty": true } } } ] }, "iam.CuiIntegration.Response": { "description": "The response body of a HTTP GET request for the 'iam.CuiIntegration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.CuiIntegration' resources.", "x-one-of-name": "iam.CuiIntegration.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.CuiIntegration.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.CuiIntegration": { "title": "Iam:Cui Integration", "description": "Stores CUI and CCC integration details and synchronization status for an account.", "x-allOf-name": "iam.CuiIntegration", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.CuiIntegration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.CuiIntegration" ], "default": "iam.CuiIntegration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.CuiIntegration" ], "default": "iam.CuiIntegration", "x-enum-as-string": true }, "CiscoCloudControlInventorySync": { "description": "CCC inventory synchronization setting.\n* `enable` - Cisco Cloud Control inventory synchronization is enabled.\n* `disable` - Cisco Cloud Control inventory synchronization is disabled.", "type": "string", "enum": [ "enable", "disable" ], "default": "enable", "readOnly": true, "x-omitempty": true }, "LastFullSyncTime": { "description": "The last-modified timestamp of the tenant as returned by the remote API during the most recent workflow-based synchronization.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastNotificationModifiedTime": { "description": "The modified-time carried by the most recent notification applied to this CUI integration MO, used to detect and skip stale or duplicate notifications.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LinkedTenants": { "type": "array", "items": { "description": "List of linked tenant information for various products (CUI, CCC).", "$ref": "#/components/schemas/iam.TenantLinking", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OptIn": { "description": "Indicates whether the account has opted in to CUI identity synchronization.", "type": "boolean", "x-omitempty": true }, "OptInTime": { "description": "Timestamp representing when the customer opted in to CUI identity synchronization.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "OptInUserIdentity": { "description": "Identity or name of the engineer who performed the opt-in action.", "type": "string", "readOnly": true, "x-omitempty": true }, "SyncStatus": { "description": "Current synchronization status of CUI integration data.\n* `Needs-Sync` - CUI integration data needs to be synchronized.\n* `InProgress` - CUI integration synchronization is in progress.\n* `Done` - CUI integration synchronization is completed.", "type": "string", "enum": [ "Needs-Sync", "InProgress", "Done" ], "default": "Needs-Sync", "readOnly": true, "x-omitempty": true }, "TenantId": { "description": "Primary tenant ID for CUI integration.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "User": { "$ref": "#/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 } } } ] }, "iam.CuiIntegration.List": { "title": "List of 'iam.CuiIntegration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.CuiIntegration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.CuiIntegration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.CuiIntegration" }, "nullable": true } } } ] }, "iam.DefaultAuthentication.Response": { "description": "The response body of a HTTP GET request for the 'iam.DefaultAuthentication' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.DefaultAuthentication' resources.", "x-one-of-name": "iam.DefaultAuthentication.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.DefaultAuthentication.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.DefaultAuthentication": { "title": "Iam:Default Authentication", "description": "DefaultAuthentication specifies the default login method for an account in appliance contexts, optionally linking to a default LDAP domain.\n#### Purpose\nIt streamlines user sign-in by preselecting the primary authentication method.\n#### Key Concepts\n- **Method Selection:** Chooses among local, SSO, or LDAP modes for default use.\n- **LDAP Affinity:** Can associate a default LDAP IdP for convenience.\n- **Account-level Policy:** Configurable by account administrators.\n- **User Experience:** Reduces friction during authentication flows.", "x-allOf-name": "iam.DefaultAuthentication", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.DefaultAuthentication', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.DefaultAuthentication" ], "default": "iam.DefaultAuthentication", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.DefaultAuthentication" ], "default": "iam.DefaultAuthentication", "x-enum-as-string": true }, "DefaultAuthenticationMethod": { "description": "The default authentication method used to login into Intersight.\n* `Local` - Local authentication uses credentials stored within the Intersight platform for user access.\n* `SSO` - SSO authentication uses an external identity provider for user access.\n* `LDAP` - LDAP authentication uses external LDAP servers for user access.", "type": "string", "enum": [ "Local", "SSO", "LDAP" ], "default": "Local", "x-omitempty": true }, "Account": { "$ref": "#/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 }, "LdapDomain": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.DefaultAuthentication.List": { "title": "List of 'iam.DefaultAuthentication' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.DefaultAuthentication' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.DefaultAuthentication' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.DefaultAuthentication" }, "nullable": true } } } ] }, "iam.DefaultPermissionInfo": { "title": "Iam:Default Permission Info", "description": "Contains information about a stored default permission and its shared login interface coverage for product-facing default role selection.", "x-allOf-name": "iam.DefaultPermissionInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.DefaultPermissionInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.DefaultPermissionInfo" ], "default": "iam.DefaultPermissionInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.DefaultPermissionInfo" ], "default": "iam.DefaultPermissionInfo", "x-enum-as-string": true }, "Interface": { "description": "The shared login interface coverage for the stored default permission.\n* `All` - The stored default permission applies to all currently supported login interfaces.", "type": "string", "enum": [ "All" ], "default": "All", "x-omitempty": true }, "Permission": { "description": "Reference to the selected default permission for the shared login interface coverage.", "$ref": "#/components/schemas/mo.MoRef", "x-omitempty": true } } } ] }, "iam.DomainGroup.Response": { "description": "The response body of a HTTP GET request for the 'iam.DomainGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.DomainGroup' resources.", "x-one-of-name": "iam.DomainGroup.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.DomainGroup.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.DomainGroup.Relationship": { "description": "A relationship to the 'iam.DomainGroup' resource, or the expanded 'iam.DomainGroup' resource, or the 'null' value.", "x-one-of-name": "iam.DomainGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.DomainGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.DomainGroup": { "title": "Iam:Domain Group", "description": "Intersight services are mapped to three different categories of services for scaling purpose.\nThree categories are defined: Partition1/Partition2/Partition3. Topics for each category are created with\na specific number of partitions. For each cloud environment these numbers will be different.", "x-allOf-name": "iam.DomainGroup", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.DomainGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.DomainGroup" ], "default": "iam.DomainGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.DomainGroup" ], "default": "iam.DomainGroup", "x-enum-as-string": true }, "Name": { "description": "The name of the domain-group.", "type": "string", "readOnly": true, "x-omitempty": true }, "Partition1": { "description": "The partition number domain group related messages are produced for 'Partition1' category service topics.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Partition2": { "description": "In a cloud environment this parameter will indicate to which partition number domain group related messages are produced for 'Partition2' category service topics.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Partition3": { "description": "In a cloud environment this parameter will indicate to which partition number domain group related messages are produced for 'Partition3' category service topics.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PartitionKey": { "description": "Partition key used for producing messages to Kafka partitions. By default Domain-group id will be used as partition key. For Domain-groups belonging to Early adopters domain-group id will be prefixed with 'H' and used as partition key, such partition key will be treated differently and messages will always be produced to partition 0.", "type": "string", "readOnly": true, "x-omitempty": true }, "Usage": { "description": "The number of devices in the domain-group.\nDevice registration notifications are processed to update the usage of the domain-group. The on-boarding account will have multiple domain-groups, and during the device registration least used domain-group will be selected for the device.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "iam.DomainGroup.List": { "title": "List of 'iam.DomainGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.DomainGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.DomainGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.DomainGroup" }, "nullable": true } } } ] }, "iam.DomainNameInfo.Response": { "description": "The response body of a HTTP GET request for the 'iam.DomainNameInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.DomainNameInfo' resources.", "x-one-of-name": "iam.DomainNameInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.DomainNameInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.DomainNameInfo": { "title": "Iam:Domain Name Info", "description": "The organisation's domain name such as cisco.com that has been used to log in to Intersight.", "x-allOf-name": "iam.DomainNameInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.DomainNameInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.DomainNameInfo" ], "default": "iam.DomainNameInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.DomainNameInfo" ], "default": "iam.DomainNameInfo", "x-enum-as-string": true }, "Action": { "description": "Regenerate TXT record and validate TXT record.\n* `generate` - Generate TXT record for domain name ownership validation.\n* `verify` - Verify TXT record for domain name ownership validation.", "type": "string", "enum": [ "generate", "verify" ], "default": "generate", "x-omitempty": true }, "DomainName": { "description": "Email domain name. When a user enters an email during login in the Intersight home page, the IdP is picked by matching this domain name with the email domain name for authentication.", "type": "string", "pattern": "^$|^[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-createOnly": true, "x-omitempty": true }, "FailureDetails": { "description": "Reason for the failure during verification.", "$ref": "#/components/schemas/iam.FailureDetails", "readOnly": true, "x-omitempty": true }, "RecordExpiryTime": { "description": "Expiration time of TXT Record.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of Domain Ownership Verification.\n* `Pending` - Domain verification is pending.\n* `Failed` - Domain verification failed. Re-generate token and verify.\n* `Verified` - Domain verification succeeded.\n* `Expired` - TXT Record for Domain verification expired.", "type": "string", "enum": [ "Pending", "Failed", "Verified", "Expired" ], "default": "Pending", "readOnly": true, "x-omitempty": true }, "TxtRecord": { "description": "Resource record used to verify Domain Ownership. Users need to verify the domain by adding the TXT Record in their DNS Host.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "iam.DomainNameInfo.List": { "title": "List of 'iam.DomainNameInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.DomainNameInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.DomainNameInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.DomainNameInfo" }, "nullable": true } } } ] }, "iam.EncryptedOidcAuthTokenSet": { "title": "Iam:Encrypted Oidc Auth Token Set", "description": "Holds attributes obtained after OIDC authentication in encrypted format which are required for CUI admin portal MFE \ninside Intersight for IdP settings and routing rules, session refresh and logout functionality. Used during login\nflow where the tokens obtained from CUI need to be stored securely.", "x-allOf-name": "iam.EncryptedOidcAuthTokenSet", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EncryptedOidcAuthTokenSet', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EncryptedOidcAuthTokenSet" ], "default": "iam.EncryptedOidcAuthTokenSet", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EncryptedOidcAuthTokenSet" ], "default": "iam.EncryptedOidcAuthTokenSet", "x-enum-as-string": true }, "IsAccessTokenSet": { "description": "Indicates whether the value of the 'accessToken' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsIdTokenSet": { "description": "Indicates whether the value of the 'idToken' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsRefreshTokenSet": { "description": "Indicates whether the value of the 'refreshToken' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true } } } ] }, "iam.EndPointPasswordProperties": { "title": "Iam:End Point Password Properties", "description": "Password properties for endpoint users.", "x-allOf-name": "iam.EndPointPasswordProperties", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointPasswordProperties', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointPasswordProperties" ], "default": "iam.EndPointPasswordProperties", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointPasswordProperties" ], "default": "iam.EndPointPasswordProperties", "x-enum-as-string": true }, "EnablePasswordExpiry": { "description": "Enables password expiry on the endpoint.", "type": "boolean", "default": false, "x-omitempty": true }, "EnforceStrongPassword": { "description": "Enables a strong password policy. Strong password requirements: A. The password must have a minimum of 8 and a maximum of 127 characters. B. The password must not contain the User's Name. C. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, #, $, %, ^, &, *, -, _, +, =).", "type": "boolean", "default": true, "x-omitempty": true }, "ForceSendPassword": { "description": "User password will always be sent to endpoint device. If the option is not selected, then user password will be sent to endpoint device for new users and if user password is changed for existing users.", "type": "boolean", "default": false, "x-omitempty": true }, "GracePeriod": { "description": "Time period until when you can use the existing password, after it expires.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 5, "x-omitempty": true }, "NotificationPeriod": { "description": "The duration after which the password will expire.", "type": "integer", "format": "int64", "default": 15, "minimum": 0, "maximum": 15, "x-omitempty": true }, "PasswordExpiryDuration": { "description": "Set time period for password expiration. Value should be greater than notification period and grace period.", "type": "integer", "format": "int64", "default": 90, "minimum": 1, "maximum": 3650, "x-omitempty": true }, "PasswordHistory": { "description": "Tracks password change history. Specifies in number of instances, that the new password was already used.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 5, "x-omitempty": true } } } ] }, "iam.EndPointPrivilege.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointPrivilege' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointPrivilege' resources.", "x-one-of-name": "iam.EndPointPrivilege.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointPrivilege.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointPrivilege.Relationship": { "description": "A relationship to the 'iam.EndPointPrivilege' resource, or the expanded 'iam.EndPointPrivilege' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointPrivilege.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointPrivilege" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointPrivilege": { "title": "Iam:End Point Privilege", "description": "EndPointPrivilege models privileges defined on managed endpoints (e.g., UCS, IMC), enabling cross-launch or delegated actions.\n#### Purpose\nIt exposes endpoint-side authorization elements that can be assigned to platform users via endpoint roles.\n#### Key Concepts\n- **Endpoint Integration:** Bridges device-level capabilities to platform users.\n- **Read-only Catalog:** Reflects endpoint-defined actions.\n- **Role Assignment:** Consumed by EndPointRole for user access.", "x-allOf-name": "iam.EndPointPrivilege", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointPrivilege', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointPrivilege" ], "default": "iam.EndPointPrivilege", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointPrivilege" ], "default": "iam.EndPointPrivilege", "x-enum-as-string": true }, "Description": { "description": "The functionality of this privilege.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the end point privilege.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the end point like Cisco UCS Fabric Interconnect or Cisco IMC.\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 }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.EndPointPrivilege.List": { "title": "List of 'iam.EndPointPrivilege' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointPrivilege' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointPrivilege' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointPrivilege" }, "nullable": true } } } ] }, "iam.EndPointRole.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointRole' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointRole' resources.", "x-one-of-name": "iam.EndPointRole.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointRole.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointRole.Relationship": { "description": "A relationship to the 'iam.EndPointRole' resource, or the expanded 'iam.EndPointRole' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointRole.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointRole" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointRole": { "title": "Iam:End Point Role", "description": "EndPointRole represents roles defined on managed endpoints that encapsulate one or more endpoint privileges.\n#### Purpose\nIt allows administrators to assign endpoint-specific capabilities to platform users in a structured way.\n#### Key Concepts\n- **Role Abstraction:** Groups endpoint privileges for ease of assignment.\n- **Device-type Aware:** Specific to endpoint platform types.\n- **User Linkage:** Assignable to users for GUI/CLI cross-launch and more.\n- **Discoverable:** Tied to endpoint-reported security models.", "x-allOf-name": "iam.EndPointRole", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointRole', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointRole" ], "default": "iam.EndPointRole", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointRole" ], "default": "iam.EndPointRole", "x-enum-as-string": true }, "Name": { "description": "The name of the end point role.", "type": "string", "readOnly": true, "x-omitempty": true }, "RoleType": { "description": "User specified tags to roles like as ep-admin or ep-readonly.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the end point like Cisco UCS Fabric Interconnect or Cisco IMC.\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 }, "Account": { "$ref": "#/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 }, "EndPointPrivileges": { "description": "An array of relationships to iamEndPointPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointPrivilege.Relationship" }, "nullable": true, "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.EndPointRole.List": { "title": "List of 'iam.EndPointRole' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointRole' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointRole' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole" }, "nullable": true } } } ] }, "iam.EndPointUser.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUser' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUser' resources.", "x-one-of-name": "iam.EndPointUser.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUser.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUser.Relationship": { "description": "A relationship to the 'iam.EndPointUser' resource, or the expanded 'iam.EndPointUser' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUser.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUser" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUser": { "title": "User", "description": "The IAM EndPointUser object represents a single local user account. It is a building block used within the EndPointUserPolicy to define the users that should be created on an endpoint.\n#### Purpose\nThe purpose is to define the identity of a local user, primarily their username. It acts as a referenceable entity that can be associated with roles and a password within the broader EndPointUserPolicy.\n#### Key Concepts\n- **User Identity:** The core function of this is to specify the name (username) of the local user.\n- **Component of a Policy:** It does not function on its own but is created as part of an EndPointUserPolicy.\n- **Reusable within an Organization:** As an organization-owned object, a single EndPointUser can be referenced in multiple EndPointUserRole mappings across different policies, though it typically represents a unique user identity.", "x-allOf-name": "iam.EndPointUser", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUser', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUser" ], "default": "iam.EndPointUser", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUser" ], "default": "iam.EndPointUser", "x-enum-as-string": true }, "Name": { "description": "Name of the user to be created on the endpoint. It can be any string that adheres to the following constraints. It can have alphanumeric characters, dots, underscores and hyphen. It cannot be more than 16 characters.", "type": "string", "pattern": "^[a-zA-Z0-9\\._\\-]+$", "maxLength": 16, "x-omitempty": true }, "EndPointUserRole": { "description": "An array of relationships to iamEndPointUserRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRole.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/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 } } } ] }, "iam.EndPointUser.List": { "title": "List of 'iam.EndPointUser' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUser' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUser' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUser" }, "nullable": true } } } ] }, "iam.EndPointUserInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserInventory' resources.", "x-one-of-name": "iam.EndPointUserInventory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserInventory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserInventory.Relationship": { "description": "A relationship to the 'iam.EndPointUserInventory' resource, or the expanded 'iam.EndPointUserInventory' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserInventory": { "title": "User", "description": "The IAM EndPointUser object represents a single local user account. It is a building block used within the EndPointUserPolicy to define the users that should be created on an endpoint.\n#### Purpose\nThe purpose is to define the identity of a local user, primarily their username. It acts as a referenceable entity that can be associated with roles and a password within the broader EndPointUserPolicy.\n#### Key Concepts\n- **User Identity:** The core function of this is to specify the name (username) of the local user.\n- **Component of a Policy:** It does not function on its own but is created as part of an EndPointUserPolicy.\n- **Reusable within an Organization:** As an organization-owned object, a single EndPointUser can be referenced in multiple EndPointUserRole mappings across different policies, though it typically represents a unique user identity.", "x-allOf-name": "iam.EndPointUserInventory", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserInventory" ], "default": "iam.EndPointUserInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserInventory" ], "default": "iam.EndPointUserInventory", "x-enum-as-string": true }, "Name": { "description": "Name of the user to be created on the endpoint. It can be any string that adheres to the following constraints. It can have alphanumeric characters, dots, underscores and hyphen. It cannot be more than 16 characters.", "type": "string", "pattern": "^[a-zA-Z0-9\\._\\-]+$", "maxLength": 16, "readOnly": true, "x-omitempty": true }, "UserId": { "description": "UserId for the end point user.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndPointUserRole": { "description": "An array of relationships to iamEndPointUserRoleInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory.Relationship" }, "nullable": true, "readOnly": true }, "TargetMo": { "$ref": "#/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 } } } ] }, "iam.EndPointUserInventory.List": { "title": "List of 'iam.EndPointUserInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserInventory" }, "nullable": true } } } ] }, "iam.EndPointUserPolicy.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserPolicy' resources.", "x-one-of-name": "iam.EndPointUserPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserPolicy.Relationship": { "description": "A relationship to the 'iam.EndPointUserPolicy' resource, or the expanded 'iam.EndPointUserPolicy' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserPolicy": { "title": "Local User", "description": "The IAM EndPointUserPolicy object is a reusable policy that enables the creation and management of local user accounts on endpoints, such as server management controllers.\n#### Purpose\nThe purpose of this policy is to standardize local user account configurations across multiple servers. It allows administrators to define password complexity rules, password expiration settings, and associate specific roles and permissions with local users, ensuring consistent and secure access control.\n#### Key Concepts\n- **Centralized User Management:** Provides a single policy to define local user accounts, their roles, and password settings that can be applied to many servers.\n- **Password Properties:** The policy includes a comprehensive set of password controls, such as enforcing strong passwords, setting expiration durations, and maintaining a password history.\n- **Role-Based Access Control:** It works in conjunction with EndPointUser and EndPointUserRole objects to map users to specific roles (e.g., admin, read-only) on the endpoint.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the user configurations to the assigned physical server.", "x-allOf-name": "iam.EndPointUserPolicy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserPolicy" ], "default": "iam.EndPointUserPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserPolicy" ], "default": "iam.EndPointUserPolicy", "x-enum-as-string": true }, "AccountLockoutDuration": { "description": "Timeout duration specifies the duration (in seconds) after which a locked account is automatically unlocked. - Set to 0 when accountUnlockMode is Manual. - Set a value between 1 and 604800 when accountUnlockMode is Automatic.", "type": "integer", "format": "int64", "default": 300, "minimum": 0, "maximum": 604800, "x-omitempty": true }, "AccountLockoutThreshold": { "description": "Set Account Lockout Threshold for endpoint users.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 65535, "x-omitempty": true }, "AccountUnlockMode": { "description": "Account unlock method specifies how the account is unlocked after it is locked: - Manual: Account must be manually unlocked by an administrator. - Automatic: Account unlocks automatically after a timeout duration.\n* `Automatic` - Set Automatic on the selected end point.\n* `Manual` - Set Manual on the selected end point.", "type": "string", "enum": [ "Automatic", "Manual" ], "default": "Automatic", "x-omitempty": true }, "PasswordProperties": { "description": "Set password properties for endpoint users.", "$ref": "#/components/schemas/iam.EndPointPasswordProperties", "x-omitempty": true }, "EndPointUserRoles": { "description": "An array of relationships to iamEndPointUserRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRole.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/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": "#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "iam.EndPointUserPolicy.List": { "title": "List of 'iam.EndPointUserPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserPolicy" }, "nullable": true } } } ] }, "iam.EndPointUserPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserPolicyInventory' resources.", "x-one-of-name": "iam.EndPointUserPolicyInventory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserPolicyInventory.Relationship": { "description": "A relationship to the 'iam.EndPointUserPolicyInventory' resource, or the expanded 'iam.EndPointUserPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserPolicyInventory": { "title": "Local User", "description": "The IAM EndPointUserPolicy object is a reusable policy that enables the creation and management of local user accounts on endpoints, such as server management controllers.\n#### Purpose\nThe purpose of this policy is to standardize local user account configurations across multiple servers. It allows administrators to define password complexity rules, password expiration settings, and associate specific roles and permissions with local users, ensuring consistent and secure access control.\n#### Key Concepts\n- **Centralized User Management:** Provides a single policy to define local user accounts, their roles, and password settings that can be applied to many servers.\n- **Password Properties:** The policy includes a comprehensive set of password controls, such as enforcing strong passwords, setting expiration durations, and maintaining a password history.\n- **Role-Based Access Control:** It works in conjunction with EndPointUser and EndPointUserRole objects to map users to specific roles (e.g., admin, read-only) on the endpoint.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the user configurations to the assigned physical server.", "x-allOf-name": "iam.EndPointUserPolicyInventory", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserPolicyInventory" ], "default": "iam.EndPointUserPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserPolicyInventory" ], "default": "iam.EndPointUserPolicyInventory", "x-enum-as-string": true }, "AccountLockoutDuration": { "description": "Timeout duration specifies the duration (in seconds) after which a locked account is automatically unlocked. - Set to 0 when accountUnlockMode is Manual. - Set a value between 1 and 604800 when accountUnlockMode is Automatic.", "type": "integer", "format": "int64", "default": 300, "minimum": 0, "maximum": 604800, "readOnly": true, "x-omitempty": true }, "AccountLockoutThreshold": { "description": "Set Account Lockout Threshold for endpoint users.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "AccountUnlockMode": { "description": "Account unlock method specifies how the account is unlocked after it is locked: - Manual: Account must be manually unlocked by an administrator. - Automatic: Account unlocks automatically after a timeout duration.\n* `Automatic` - Set Automatic on the selected end point.\n* `Manual` - Set Manual on the selected end point.", "type": "string", "enum": [ "Automatic", "Manual" ], "default": "Automatic", "readOnly": true, "x-omitempty": true }, "PasswordProperties": { "description": "Set password properties for endpoint users.", "$ref": "#/components/schemas/iam.EndPointPasswordProperties", "readOnly": true, "x-omitempty": true }, "EndPointUserRoles": { "description": "An array of relationships to iamEndPointUserRoleInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory.Relationship" }, "nullable": true, "readOnly": true }, "TargetMo": { "$ref": "#/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 } } } ] }, "iam.EndPointUserPolicyInventory.List": { "title": "List of 'iam.EndPointUserPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory" }, "nullable": true } } } ] }, "iam.EndPointUserRole.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserRole' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserRole' resources.", "x-one-of-name": "iam.EndPointUserRole.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserRole.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserRole.Relationship": { "description": "A relationship to the 'iam.EndPointUserRole' resource, or the expanded 'iam.EndPointUserRole' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserRole.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserRole" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserRole": { "title": "Iam:End Point User Role", "description": "The IAM EndPointUserRole object is a mapping object that links a local user to their assigned roles and password within the context of an EndPointUserPolicy.\n#### Purpose\nThe IAM EndPointUserRole objects purpose is to bind together three key pieces of information: the user, their password, and their permissions. It serves as the mechanism for granting specific roles (like admin or read-only) to an EndPointUser and securely storing the encrypted password for that user's account on the endpoint.\n#### Key Concepts\n- **User-Role-Password Mapping:** It connects an EndPointUser object with a collection of EndPointRole objects and contains the password for that user.\n- **Secure Password Handling:** The password property is write-only and encrypted, ensuring credentials are not exposed after being set.\n- **Component of a Policy:** It exists as part of the endPointUserRoles collection within an EndPointUserPolicy and is essential for defining a complete user account.\n- **Account Status:** Includes an enabled flag to control whether the user account is active on the endpoint.", "x-allOf-name": "iam.EndPointUserRole", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserRole', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserRole" ], "default": "iam.EndPointUserRole", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserRole" ], "default": "iam.EndPointUserRole", "x-enum-as-string": true }, "AccountTypeUserDefined": { "description": "Allows to choose custom account types for the endpoint user.", "type": "boolean", "default": false, "x-omitempty": true }, "AccountTypes": { "type": "array", "items": { "description": "Type of account to be created on the endpoint. localUser - Creates a local user on the endpoint. IPMIUser - Creates an IPMI user on the endpoint.", "$ref": "#/components/schemas/iam.AccountTypeBase", "x-omitempty": true }, "nullable": true }, "ChangePassword": { "description": "Denotes whether password has changed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Enables the user account on the endpoint.", "type": "boolean", "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": "The password must have a minimum of 8 and a maximum of 127 characters. For servers with IPMI user role enabled, the maximum length is limited to 20 characters. When strong password is enabled, must satisfy below requirements: A. The password must not contain the User's Name. B. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, #, $, %, ^, &, *, -, _, +, =).", "type": "string", "pattern": "^$|^[a-zA-Z0-9!@#$%^&\\*+-_=]+$", "minLength": 8, "maxLength": 127, "writeOnly": true, "x-omitempty": true }, "EndPointRole": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true }, "EndPointUser": { "$ref": "#/components/schemas/iam.EndPointUser.Relationship", "description": "A reference to a iamEndPointUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "EndPointUserPolicy": { "$ref": "#/components/schemas/iam.EndPointUserPolicy.Relationship", "description": "A reference to a iamEndPointUserPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.EndPointUserRole.List": { "title": "List of 'iam.EndPointUserRole' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserRole' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserRole' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRole" }, "nullable": true } } } ] }, "iam.EndPointUserRoleInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.EndPointUserRoleInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.EndPointUserRoleInventory' resources.", "x-one-of-name": "iam.EndPointUserRoleInventory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.EndPointUserRoleInventory.Relationship": { "description": "A relationship to the 'iam.EndPointUserRoleInventory' resource, or the expanded 'iam.EndPointUserRoleInventory' resource, or the 'null' value.", "x-one-of-name": "iam.EndPointUserRoleInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.EndPointUserRoleInventory": { "title": "Iam:End Point User Role Inventory", "description": "The IAM EndPointUserRole object is a mapping object that links a local user to their assigned roles and password within the context of an EndPointUserPolicy.\n#### Purpose\nThe IAM EndPointUserRole objects purpose is to bind together three key pieces of information: the user, their password, and their permissions. It serves as the mechanism for granting specific roles (like admin or read-only) to an EndPointUser and securely storing the encrypted password for that user's account on the endpoint.\n#### Key Concepts\n- **User-Role-Password Mapping:** It connects an EndPointUser object with a collection of EndPointRole objects and contains the password for that user.\n- **Secure Password Handling:** The password property is write-only and encrypted, ensuring credentials are not exposed after being set.\n- **Component of a Policy:** It exists as part of the endPointUserRoles collection within an EndPointUserPolicy and is essential for defining a complete user account.\n- **Account Status:** Includes an enabled flag to control whether the user account is active on the endpoint.", "x-allOf-name": "iam.EndPointUserRoleInventory", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.EndPointUserRoleInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.EndPointUserRoleInventory" ], "default": "iam.EndPointUserRoleInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.EndPointUserRoleInventory" ], "default": "iam.EndPointUserRoleInventory", "x-enum-as-string": true }, "AccountTypeUserDefined": { "description": "Allows to choose custom account types for the endpoint user.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "AccountTypes": { "type": "array", "items": { "description": "Type of account to be created on the endpoint. localUser - Creates a local user on the endpoint. IPMIUser - Creates an IPMI user on the endpoint.", "$ref": "#/components/schemas/iam.AccountTypeBase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ChangePassword": { "description": "Denotes whether password has changed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Enables the user account on the endpoint.", "type": "boolean", "readOnly": true, "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": "The password must have a minimum of 8 and a maximum of 127 characters. For servers with IPMI user role enabled, the maximum length is limited to 20 characters. When strong password is enabled, must satisfy below requirements: A. The password must not contain the User's Name. B. The password must contain characters from three of the following four categories. 1) English uppercase characters (A through Z). 2) English lowercase characters (a through z). 3) Base 10 digits (0 through 9). 4) Non-alphabetic characters (! , @, #, $, %, ^, &, *, -, _, +, =).", "type": "string", "pattern": "^$|^[a-zA-Z0-9!@#$%^&\\*+-_=]+$", "minLength": 8, "maxLength": 127, "writeOnly": true, "x-omitempty": true }, "EndPointRole": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "EndPointUser": { "$ref": "#/components/schemas/iam.EndPointUserInventory.Relationship", "description": "A reference to a iamEndPointUserInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EndPointUserPolicy": { "$ref": "#/components/schemas/iam.EndPointUserPolicyInventory.Relationship", "description": "A reference to a iamEndPointUserPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.EndPointUserRoleInventory.List": { "title": "List of 'iam.EndPointUserRoleInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.EndPointUserRoleInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.EndPointUserRoleInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointUserRoleInventory" }, "nullable": true } } } ] }, "iam.FailureDetails": { "title": "Iam:Failure Details", "description": "This has information including reason annd timestamp of failure event.", "x-allOf-name": "iam.FailureDetails", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.FailureDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.FailureDetails" ], "default": "iam.FailureDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.FailureDetails" ], "default": "iam.FailureDetails", "x-enum-as-string": true }, "FailureReason": { "description": "Reason for the failure during verification.", "type": "string", "readOnly": true, "x-omitempty": true }, "FailureTime": { "description": "Timestamp of the failure during verification.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true } } } ] }, "iam.FeatureDefinition": { "title": "Iam:Feature Definition", "description": "Feature parameters specified for the account.", "x-allOf-name": "iam.FeatureDefinition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.FeatureDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.FeatureDefinition" ], "default": "iam.FeatureDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.FeatureDefinition" ], "default": "iam.FeatureDefinition", "x-enum-as-string": true }, "Feature": { "description": "The beta feature that will be enabled for specific account.\n* `IWO` - Intersight Workflow Optimizer.\n* `Hitachi` - Support to claim Hitachi Storage arrays using the Intersight Orchestrator framework.\n* `KubernetesExtension` - Extension to the IKS and Adopted Clusters.\n* `NetAppIO` - Support to claim NetApp Storage arrays as IO targets.\n* `IvsPublicCloud` - Enables virtualization service for public clouds.\n* `TerraformCloud` - Enables an ability to create Terraform Cloud.\n* `WashingtonEFT` - Support for EFT customers to use Washington firmware images for upgrades.\n* `Solutions` - Support for managing solutions.\n* `IksBm` - Enables Intersight Kubernetes Service on Baremetal server.\n* `NexusCloud` - Enables Nexus Cloud services functionality.\n* `NexusCloudTrial` - Enables Nexus Cloud trial period.\n* `NexusCloudUpgradeAssist` - Enables Nexus Cloud upgrade assist.\n* `NexusCloudSustainability` - Enables Nexus Cloud sustainability.\n* `PlatformUIRefresh` - Enables platform refreshed UI with new service launcher.\n* `IksGpu` - Enables GPU support for Intersight Kubernetes Service.\n* `IwoAppServiceVerticalScaling` - Enables vertical Scaling of App Service Plans.\n* `IwoDataExporter` - Enables IWO Data Exporter component.\n* `IwoMigrate` - Enables IWO data Migration.\n* `NexusCloudTechPreviewGold` - Enable Nexus Cloud Preview of stable features, available for public consumption.\n* `NexusCloudTechPreviewSilver` - Enable Nexus Cloud Preview of beta features. This feature set is intended for consumption by internal audiences.\n* `NexusCloudTechPreviewBronze` - Enable Nexus Cloud Preview of features still in development. This feature set is intended for consumption by internal audiences.\n* `DisconnectedTargetAlarm` - Raise an alarm when a Target is disconnected from Intersight. Intersight is unable to manage disconnected Targets.\n* `AsAService` - Enable AsAService Preview of beta features. This feature set is intended for consumption by selective audiences.\n* `EMEA` - Enable all avaialble features on Intersight EMEA region.\n* `CrossPlatformNavigation` - Enable Cross-Platform Navigation on UI.\n* `WorkflowsPreview` - Enable Workflows preview for this account.\n* `WorkflowsIntersightAssets` - Enable workflow Intersight assets for this account.\n* `ManualKEKSupport` - Enable support for Manual key to enhance storage controller security for this account.\n* `FirmwareConsolidationEFT` - Enable usage of firmware images transitioned from CCO to Intersight. This feature set is intended for consumption by internal audiences.\n* `FunctionAsAService` - Enable the usage of the function as a service (faas) for Workflows. This feature set is intended for consumption by selective audiences.\n* `FI6664EFT` - Support for EFT customers to use FI-6664 in Port Policy.\n* `GranularPrivilegeSets` - Enable granular privilege sets for this account.\n* `UnifiedEdge` - Enable Unified Edge related features for Avatar Platform.\n* `Goldeneye` - Enable Goldeneye related features.\n* `FI6652EFT` - Support for EFT customers to use FI-6652 in Port Policy.\n* `BackupAndRestore` - Enable Backup and Restore functionality for this account.\n* `CUIIntegration` - Enables Cisco Unified Identity (CUI) integration for Intersight accounts. With this flag, customers access their accounts using the intersight.com/cui URI and CUI IdP. Standard CCI or SSO login flows remain available during the transition period. Cisco Cloud Control customers must use /cui to create new accounts or contact Product Management to enable this feature to existing accounts, to use Cisco Cloud Control and Cisco Unified Identity.\n* `UnifiedEdgeSRN` - Enable Unified Edge Secure Router Node related features for Avatar Platform.", "type": "string", "enum": [ "IWO", "Hitachi", "KubernetesExtension", "NetAppIO", "IvsPublicCloud", "TerraformCloud", "WashingtonEFT", "Solutions", "IksBm", "NexusCloud", "NexusCloudTrial", "NexusCloudUpgradeAssist", "NexusCloudSustainability", "PlatformUIRefresh", "IksGpu", "IwoAppServiceVerticalScaling", "IwoDataExporter", "IwoMigrate", "NexusCloudTechPreviewGold", "NexusCloudTechPreviewSilver", "NexusCloudTechPreviewBronze", "DisconnectedTargetAlarm", "AsAService", "EMEA", "CrossPlatformNavigation", "WorkflowsPreview", "WorkflowsIntersightAssets", "ManualKEKSupport", "FirmwareConsolidationEFT", "FunctionAsAService", "FI6664EFT", "GranularPrivilegeSets", "UnifiedEdge", "Goldeneye", "FI6652EFT", "BackupAndRestore", "CUIIntegration", "UnifiedEdgeSRN" ], "default": "IWO", "x-omitempty": true } } } ] }, "iam.GroupPermissionToRoles": { "title": "Iam:Group Permission To Roles", "description": "Complex type representing the associated resource groups, organizations and the permission to roles mapping.", "x-allOf-name": "iam.GroupPermissionToRoles", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.GroupPermissionToRoles', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.GroupPermissionToRoles" ], "default": "iam.GroupPermissionToRoles", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.GroupPermissionToRoles" ], "default": "iam.GroupPermissionToRoles", "x-enum-as-string": true }, "Group": { "description": "Moid of the resource group.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Orgs": { "type": "array", "items": { "description": "Moids of the associated organizations.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.GuestAccessSettings.Response": { "description": "The response body of a HTTP GET request for the 'iam.GuestAccessSettings' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.GuestAccessSettings' resources.", "x-one-of-name": "iam.GuestAccessSettings.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.GuestAccessSettings.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.GuestAccessSettings": { "title": "Iam:Guest Access Settings", "description": "Stores account level settings for guest user access.", "x-allOf-name": "iam.GuestAccessSettings", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.GuestAccessSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.GuestAccessSettings" ], "default": "iam.GuestAccessSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.GuestAccessSettings" ], "default": "iam.GuestAccessSettings", "x-enum-as-string": true }, "AllowedDomainNames": { "type": "array", "items": { "description": "Stores list of email domain names that are allowed for accessing an account. It is typically managed by an Account Admin who seeks to control and limit guest user logins based on their email domains. By specifying these domains, the administrator can ensure that users with email addresses from certain domains are allowed log in or registering as guests.", "type": "string", "pattern": "^[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 }, "MaxGuestAccessLinkShelfLife": { "description": "Stores the maximum duration (in seconds) during which guest access link remains valid and accessible. It is the maximum value that is set at the account level which account admin can configure. Any guest access link that is set with expiration time beyond this property will be disallowed. The default value is set to 604800 seconds (7 days).", "type": "integer", "format": "int64", "default": 604800, "minimum": 86400, "maximum": 31104000, "x-omitempty": true }, "OverrideIpAccessRestriction": { "description": "Stores an option for Account Admin to override IP Access Restriction if it is enabled in the Account. This option is used to disable IP Access restrictions for guest users logging in to the account, while restriction is enforced for other normal users (who are authenticated via SAML or LDAP).", "type": "boolean", "x-omitempty": true }, "ResourceLimits": { "$ref": "#/components/schemas/iam.ResourceLimits.Relationship", "description": "A reference to a iamResourceLimits resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.GuestAccessSettings.List": { "title": "List of 'iam.GuestAccessSettings' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.GuestAccessSettings' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.GuestAccessSettings' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.GuestAccessSettings" }, "nullable": true } } } ] }, "iam.Idp.Response": { "description": "The response body of a HTTP GET request for the 'iam.Idp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Idp' resources.", "x-one-of-name": "iam.Idp.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Idp.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Idp.Relationship": { "description": "A relationship to the 'iam.Idp' resource, or the expanded 'iam.Idp' resource, or the 'null' value.", "x-one-of-name": "iam.Idp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Idp" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Idp": { "title": "Iam:Idp", "description": "The SAML identity provider such as Cisco, that has been used to log in to Intersight.", "x-allOf-name": "iam.Idp", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Idp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Idp" ], "default": "iam.Idp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Idp" ], "default": "iam.Idp", "x-enum-as-string": true }, "DomainName": { "description": "Email domain name of the user for this IdP. When a user enters an email during login in the Intersight home page, the IdP is picked by matching this domain name with the email domain name for authentication.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "pattern": "^$|^[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 }, "DomainNames": { "type": "array", "items": { "description": "Collection of domain names that the end user wants to tie to particular IdP.", "type": "string", "pattern": "^$|^[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": 0, "maxItems": 20, "nullable": true }, "EnableSingleLogout": { "description": "Setting that indicates whether 'Single Logout (SLO)' has been enabled for this IdP.", "type": "boolean", "x-omitempty": true }, "IdpEntityId": { "description": "The Entity ID of the IdP. In SAML, the entity ID uniquely identifies the IdP or Service Provider.", "type": "string", "readOnly": true, "x-omitempty": true }, "Metadata": { "description": "SAML metadata of the IdP.", "type": "string", "x-omitempty": true }, "Name": { "description": "The name of the Identity Provider, for example Cisco, Okta, or OneID.", "type": "string", "x-omitempty": true }, "SkipWarning": { "description": "When users attempt the Account URL login with an unverified Domain Name, they get a warning stating that they are logging in using an unverified Domain Name. Enable the slider if you do not wish to see the warning message.", "type": "boolean", "x-omitempty": true }, "Type": { "description": "Authentication protocol used by the IdP.\n* `saml` - Use SAML as the authentication protocol for sign-on.\n* `oidc` - Open ID connect to be used as an authentication protocol for sign-on.\n* `local` - The local authentication method to be used for sign-on. Local type is set to default for the Intersight Appliance IdP.\n* `guest` - Guest users accessing Intersight are assigned to a guest Identity Provider (IdP). They do not have single sign-on options available and must log in using their email address and a one-time password (OTP). Upon successful authentication, all guest users associated with the account are grouped under the guest IdP. Guest IdP is primarily used in cloud environment.", "type": "string", "enum": [ "saml", "oidc", "local", "guest" ], "default": "saml", "x-omitempty": true }, "Account": { "$ref": "#/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 }, "LdapMeta": { "$ref": "#/components/schemas/iam.LdapMeta.Relationship", "description": "A reference to a iamLdapMeta resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicy.Relationship", "description": "A reference to a iamLdapPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "TestIdp": { "$ref": "#/components/schemas/iam.TestIdpConfiguration.Relationship", "description": "A reference to a iamTestIdpConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "UserPreferences": { "description": "An array of relationships to iamUserPreference resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserPreference.Relationship" }, "nullable": true, "readOnly": true }, "UserSettings": { "description": "An array of relationships to iamUserSetting resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserSetting.Relationship" }, "nullable": true, "readOnly": true }, "Usergroups": { "description": "An array of relationships to iamUserGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup.Relationship" }, "nullable": true }, "Users": { "description": "An array of relationships to iamUser resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User.Relationship" }, "nullable": true } } } ] }, "iam.Idp.List": { "title": "List of 'iam.Idp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Idp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Idp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Idp" }, "nullable": true } } } ] }, "iam.IdpReference.Response": { "description": "The response body of a HTTP GET request for the 'iam.IdpReference' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.IdpReference' resources.", "x-one-of-name": "iam.IdpReference.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.IdpReference.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.IdpReference.Relationship": { "description": "A relationship to the 'iam.IdpReference' resource, or the expanded 'iam.IdpReference' resource, or the 'null' value.", "x-one-of-name": "iam.IdpReference.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.IdpReference" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.IdpReference": { "title": "Iam:Idp Reference", "description": "The IdpReference object represents the system-provided Cisco IdP association within an account, acting as the default reference for user and group assignments.\n#### Purpose\nIdpReference simplifies managing the default IdP relationship for user onboarding, preferences, and access.\n#### Key Concepts\n- **Default IdP linkage:** Provides a stable, system-backed IdP reference.\n- **User/group Association:** Central to managing users and groups tied to the Cisco IdP.\n- **Preference Anchor:** Links user UI preferences and settings to the IdP context.\n- **Account Scope:** Managed within the owning account's boundaries.", "x-allOf-name": "iam.IdpReference", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.IdpReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.IdpReference" ], "default": "iam.IdpReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.IdpReference" ], "default": "iam.IdpReference", "x-enum-as-string": true }, "DomainName": { "description": "The DomainNameInfo object represents an organization\u2019s email domain used during login mapping and ownership verification. It supports verifying domain control via DNS to enhance trust.\n#### Purpose\nDomainNameInfo ensures that only verified domains are used to route users to the correct identity provider, improving login integrity.\n#### Key Concepts\n- **Domain Routing:** Associates email domains with IdPs for seamless login.\n- **Ownership Verification:** Supports DNS-based verification for trust establishment.\n- **Status Tracking:** Maintains domain verification lifecycle state.\n- **Account Scoped:** Managed within the context of the owning account.", "type": "string", "readOnly": true, "x-omitempty": true }, "IdpEntityId": { "description": "Entity ID of the IdP. In SAML, the entity ID uniquely identifies the IdP/Service Provider.", "type": "string", "readOnly": true, "x-omitempty": true }, "MultiFactorAuthentication": { "description": "The flag represents if the second factor of authentication is required for Cisco IdP users.", "type": "boolean", "default": false, "x-omitempty": true }, "Name": { "description": "Cisco IdP reference in an account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "UserPreferences": { "description": "An array of relationships to iamUserPreference resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserPreference.Relationship" }, "nullable": true, "readOnly": true }, "UserSettings": { "description": "An array of relationships to iamUserSetting resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserSetting.Relationship" }, "nullable": true, "readOnly": true }, "Usergroups": { "description": "An array of relationships to iamUserGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup.Relationship" }, "nullable": true }, "Users": { "description": "An array of relationships to iamUser resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User.Relationship" }, "nullable": true } } } ] }, "iam.IdpReference.List": { "title": "List of 'iam.IdpReference' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.IdpReference' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.IdpReference' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IdpReference" }, "nullable": true } } } ] }, "iam.IpAccessManagement.Response": { "description": "The response body of a HTTP GET request for the 'iam.IpAccessManagement' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.IpAccessManagement' resources.", "x-one-of-name": "iam.IpAccessManagement.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.IpAccessManagement.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.IpAccessManagement.Relationship": { "description": "A relationship to the 'iam.IpAccessManagement' resource, or the expanded 'iam.IpAccessManagement' resource, or the 'null' value.", "x-one-of-name": "iam.IpAccessManagement.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.IpAccessManagement" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.IpAccessManagement": { "title": "IP Access Management", "description": "IpAccessManagement governs IP-based access restrictions for an account, enabling administrators to allowlist trusted ranges and recover from misconfiguration.\n#### Purpose\nIt provides an additional security control layer that restricts access to the account based on client IP addresses.\n#### Key Concepts\n- **Allowlisting:** Enforces access based on configured addresses and ranges.\n- **Recovery Controls:** Supports account recovery from restrictive misconfigurations.\n- **Policy Toggle:** Enables or disables IP restriction enforcement.\n- **Centralized Management:** Hosted under the account\u2019s security holder.", "x-allOf-name": "iam.IpAccessManagement", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.IpAccessManagement', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.IpAccessManagement" ], "default": "iam.IpAccessManagement", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.IpAccessManagement" ], "default": "iam.IpAccessManagement", "x-enum-as-string": true }, "Enable": { "description": "Flag stores the state of IP address based access management. Access management is enabled when it's true.", "type": "boolean", "x-omitempty": true }, "LastRecoveryTime": { "description": "The access to account gets locked out if wrong IP addresses are configured. Account Administrators have privilege to unblock the account. It stores the time when the account was last recovered from lock out.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Holder": { "$ref": "#/components/schemas/iam.SecurityHolder.Relationship", "description": "A reference to a iamSecurityHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IpAddresses": { "description": "An array of relationships to iamIpAddress resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IpAddress.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.IpAccessManagement.List": { "title": "List of 'iam.IpAccessManagement' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.IpAccessManagement' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.IpAccessManagement' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IpAccessManagement" }, "nullable": true } } } ] }, "iam.IpAddress.Response": { "description": "The response body of a HTTP GET request for the 'iam.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 'iam.IpAddress' resources.", "x-one-of-name": "iam.IpAddress.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.IpAddress.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.IpAddress.Relationship": { "description": "A relationship to the 'iam.IpAddress' resource, or the expanded 'iam.IpAddress' resource, or the 'null' value.", "x-one-of-name": "iam.IpAddress.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.IpAddress" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.IpAddress": { "title": "IP Address", "description": "IpAddress represents a single allowlisted IP, CIDR block, or range used by IpAccessManagement.\n#### Purpose\nIt models an individual entry in the IP access policy to refine allowed sources.\n#### Key Concepts\n- **Entry Granularity:** Supports point IPs, CIDR, and address ranges.\n- **Descriptive Policy:** Accommodates human-readable rationale for entries.\n- **Policy Membership:** Always associated with an IpAccessManagement policy.\n- **Enforcement-ready:** Used directly in access control evaluations.", "x-allOf-name": "iam.IpAddress", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.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": [ "iam.IpAddress" ], "default": "iam.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": [ "iam.IpAddress" ], "default": "iam.IpAddress", "x-enum-as-string": true }, "Address": { "description": "The Trusted IP range's address. IP address, CIDR range, and IP address range formats are supported. For example '12.13.14.15', '12.13.14.0/24', and '12.13.14.15-12.13.14.200'. Reserved IP ranges '127.0.0.1', '10.0.0.0/8', '172.16.0.0/12', and '192.168.0.0/16' are not allowed.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description of Trusted IP address range.", "type": "string", "x-omitempty": true }, "IpAccessManagement": { "$ref": "#/components/schemas/iam.IpAccessManagement.Relationship", "description": "A reference to a iamIpAccessManagement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.IpAddress.List": { "title": "List of 'iam.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.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 'iam.IpAddress' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.IpAddress" }, "nullable": true } } } ] }, "iam.LdapBaseProperties": { "title": "Iam:Ldap Base Properties", "description": "Base settings of LDAP required while configuring LDAP policy.", "x-allOf-name": "iam.LdapBaseProperties", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapBaseProperties', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapBaseProperties" ], "default": "iam.LdapBaseProperties", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapBaseProperties" ], "default": "iam.LdapBaseProperties", "x-enum-as-string": true }, "Attribute": { "description": "Role and locale information of the user.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9\\-\\.]*[a-zA-Z0-9\\-]$", "x-omitempty": true }, "BaseDn": { "description": "Base Distinguished Name (DN), the starting point for searching users and groups.", "type": "string", "maxLength": 254, "x-omitempty": true }, "BindDn": { "description": "Distinguished Name (DN) used to authenticate against LDAP servers.", "type": "string", "minLength": 0, "maxLength": 254, "x-omitempty": true }, "BindMethod": { "description": "Authentication method to access LDAP servers.\n* `LoginCredentials` - Requires the user credentials. If the bind process fails, then user is denied access.\n* `Anonymous` - Requires no username and password. If this option is selected and the LDAP server is configured for Anonymous logins, then the user gains access.\n* `ConfiguredCredentials` - Requires a known set of credentials to be specified for the initial bind process. If the initial bind process succeeds, then the distinguished name (DN) of the user name is queried and re-used for the re-binding process. If the re-binding process fails, then the user is denied access.", "type": "string", "enum": [ "LoginCredentials", "Anonymous", "ConfiguredCredentials" ], "default": "LoginCredentials", "x-omitempty": true }, "Domain": { "description": "The IPv4 domain that all users must be in.", "type": "string", "pattern": "^$|^(([a-zA-Z0-9])|([a-zA-Z0-9][a-zA-Z0-9\\.\\-]*[a-zA-Z0-9]))$", "maxLength": 255, "x-omitempty": true }, "EnableEncryption": { "description": "If enabled, the endpoint encrypts all information sent to the LDAP server.", "type": "boolean", "x-omitempty": true }, "EnableGroupAuthorization": { "description": "If enabled, user authorization is also done at the group level for LDAP users not in the local user database.", "type": "boolean", "x-omitempty": true }, "EnableNestedGroupSearch": { "description": "If enabled, an extended search walks the ancestry chain to the root and returns all groups and subgroups recursively.", "type": "boolean", "default": false, "x-omitempty": true }, "Filter": { "description": "Criteria to identify entries in search requests.", "type": "string", "pattern": "^$|^[a-zA-Z0-9(][a-zA-Z0-9_#@$%&\\-\\^|()*=:!,.]*[a-zA-Z0-9\\-)]$", "x-omitempty": true }, "GroupAttribute": { "description": "Groups to which an LDAP entry belongs.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9_#@$%&\\-\\^]*[a-zA-Z0-9\\-]$", "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 }, "NestedGroupSearchDepth": { "description": "Search depth to look for a nested LDAP group in an LDAP group map.", "type": "integer", "format": "int64", "default": 128, "minimum": 1, "maximum": 128, "x-omitempty": true }, "Password": { "description": "The password for the initial bind process. Must not contain spaces, tabs, or line breaks, and cannot exceed 254 characters.", "type": "string", "pattern": "^[\\S+]{0,254}$", "writeOnly": true, "x-omitempty": true }, "Timeout": { "description": "LDAP authentication timeout duration, in seconds.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 180, "x-omitempty": true }, "UserSearchAttribute": { "type": "array", "items": { "description": "LDAP attributes used for username matching during authentication.\nMultiple attributes create an OR condition in the search filter.\nExamples: \"mail\", \"sAMAccountName\", \"uid\".\nLeave blank to use default attributes: \"mail\", \"sAMAccountName\".", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "iam.LdapConfigParams.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapConfigParams' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapConfigParams' resources.", "x-one-of-name": "iam.LdapConfigParams.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapConfigParams.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapConfigParams": { "title": "Iam:Ldap Config Params", "description": "LdapConfigParams stores additional configuration metadata used internally to support LDAP integration in appliance contexts.\n#### Purpose\nIt centralizes internal parameters that influence LDAP issuer and connector behaviors.\n#### Key Concepts\n- **Internal Config:** Not end-user facing; supports system connectors.\n- **Issuer Derivation:** Assists in building correct LDAP issuer URLs.\n- **Account Binding:** Parameters are scoped to the owning account.\n- **Lifecycle Managed:** Maintained by system services for stability.", "x-allOf-name": "iam.LdapConfigParams", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapConfigParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapConfigParams" ], "default": "iam.LdapConfigParams", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapConfigParams" ], "default": "iam.LdapConfigParams", "x-enum-as-string": true }, "ConfigHost": { "description": "Stores the hostname based on which the issuer URL should be generated.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "iam.LdapConfigParams.List": { "title": "List of 'iam.LdapConfigParams' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapConfigParams' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapConfigParams' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapConfigParams" }, "nullable": true } } } ] }, "iam.LdapDnsParameters": { "title": "Iam:Ldap Dns Parameters", "description": "DNS settings used to access LDAP Providers.", "x-allOf-name": "iam.LdapDnsParameters", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapDnsParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapDnsParameters" ], "default": "iam.LdapDnsParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapDnsParameters" ], "default": "iam.LdapDnsParameters", "x-enum-as-string": true }, "SearchDomain": { "description": "Domain name that acts as a source for a DNS query.", "type": "string", "pattern": "^$|^(([a-zA-Z0-9])|([a-zA-Z0-9][a-zA-Z0-9\\.\\-]*[a-zA-Z0-9]))$", "maxLength": 64, "x-omitempty": true }, "SearchForest": { "description": "Forest name that acts as a source for a DNS query.", "type": "string", "pattern": "^$|^(([a-zA-Z0-9])|([a-zA-Z0-9][a-zA-Z0-9\\.\\-]*[a-zA-Z0-9]))$", "maxLength": 64, "x-omitempty": true }, "Source": { "description": "Source of the domain name used for the DNS SRV request.\n* `Extracted` - The domain name extracted-domain from the login ID.\n* `Configured` - The configured-search domain.\n* `ConfiguredExtracted` - The domain name extracted from the login ID than the configured-search domain.", "type": "string", "enum": [ "Extracted", "Configured", "ConfiguredExtracted" ], "default": "Extracted", "x-omitempty": true } } } ] }, "iam.LdapGroup.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapGroup' resources.", "x-one-of-name": "iam.LdapGroup.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapGroup.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapGroup.Relationship": { "description": "A relationship to the 'iam.LdapGroup' resource, or the expanded 'iam.LdapGroup' resource, or the 'null' value.", "x-one-of-name": "iam.LdapGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapGroup": { "title": "Iam:Ldap Group", "description": "The LDAP Group object creates a mapping between a group in a remote LDAP directory and a set of local roles on an endpoint.\n#### Purpose\nThe purpose is to grant permissions to remote users. When a user authenticates via LDAP and is found to be a member of a specified LDAP group, they are granted the permissions of the EndPointRoles associated with this LdapGroup object. This enables role-based access control for remote directory users.\n#### Key Concepts\n- **Group-to-Role Mapping:** Its core function is to link an LDAP group name (or DN) to one or more local endpoint roles (e.g., admin, read-only).\n- **Component of a Policy:** It is always defined within the context of an LdapPolicy.\n- **Authorization Mechanism:** Serves as the primary mechanism for authorizing remote users by assigning them appropriate privileges based on their directory group membership.", "x-allOf-name": "iam.LdapGroup", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapGroup" ], "default": "iam.LdapGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapGroup" ], "default": "iam.LdapGroup", "x-enum-as-string": true }, "Domain": { "description": "LDAP server domain the Group resides in.", "type": "string", "pattern": "^$|^[a-zA-Z0-9-]+(.[a-zA-Z0-9-]+)*$", "maxLength": 255, "x-omitempty": true }, "GroupDn": { "description": "LDAP Group DN in the LDAP server database.", "type": "string", "pattern": "^$|^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$", "maxLength": 300, "x-omitempty": true }, "Name": { "description": "LDAP Group name in the LDAP server database.", "type": "string", "pattern": "^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$", "maxLength": 127, "x-omitempty": true }, "EndPointRole": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicy.Relationship", "description": "A reference to a iamLdapPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.LdapGroup.List": { "title": "List of 'iam.LdapGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapGroup" }, "nullable": true } } } ] }, "iam.LdapGroupInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapGroupInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapGroupInventory' resources.", "x-one-of-name": "iam.LdapGroupInventory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapGroupInventory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapGroupInventory.Relationship": { "description": "A relationship to the 'iam.LdapGroupInventory' resource, or the expanded 'iam.LdapGroupInventory' resource, or the 'null' value.", "x-one-of-name": "iam.LdapGroupInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapGroupInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapGroupInventory": { "title": "Iam:Ldap Group Inventory", "description": "The LDAP Group object creates a mapping between a group in a remote LDAP directory and a set of local roles on an endpoint.\n#### Purpose\nThe purpose is to grant permissions to remote users. When a user authenticates via LDAP and is found to be a member of a specified LDAP group, they are granted the permissions of the EndPointRoles associated with this LdapGroup object. This enables role-based access control for remote directory users.\n#### Key Concepts\n- **Group-to-Role Mapping:** Its core function is to link an LDAP group name (or DN) to one or more local endpoint roles (e.g., admin, read-only).\n- **Component of a Policy:** It is always defined within the context of an LdapPolicy.\n- **Authorization Mechanism:** Serves as the primary mechanism for authorizing remote users by assigning them appropriate privileges based on their directory group membership.", "x-allOf-name": "iam.LdapGroupInventory", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapGroupInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapGroupInventory" ], "default": "iam.LdapGroupInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapGroupInventory" ], "default": "iam.LdapGroupInventory", "x-enum-as-string": true }, "Domain": { "description": "LDAP server domain the Group resides in.", "type": "string", "pattern": "^$|^[a-zA-Z0-9-]+(.[a-zA-Z0-9-]+)*$", "maxLength": 255, "readOnly": true, "x-omitempty": true }, "GroupDn": { "description": "LDAP Group DN in the LDAP server database.", "type": "string", "pattern": "^$|^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$", "maxLength": 300, "readOnly": true, "x-omitempty": true }, "Name": { "description": "LDAP Group name in the LDAP server database.", "type": "string", "pattern": "^([^+\\-][a-zA-Z0-9=!#$%()*+,-.:;@ _{|}~?&]*)$", "maxLength": 127, "readOnly": true, "x-omitempty": true }, "EndPointRole": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicyInventory.Relationship", "description": "A reference to a iamLdapPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.LdapGroupInventory.List": { "title": "List of 'iam.LdapGroupInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapGroupInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapGroupInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapGroupInventory" }, "nullable": true } } } ] }, "iam.LdapMeta.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapMeta' resources.", "x-one-of-name": "iam.LdapMeta.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapMeta.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapMeta.Relationship": { "description": "A relationship to the 'iam.LdapMeta' resource, or the expanded 'iam.LdapMeta' resource, or the 'null' value.", "x-one-of-name": "iam.LdapMeta.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapMeta" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapMeta": { "title": "Iam:Ldap Meta", "description": "LdapMeta stores metadata for internal LDAP connectors created to support an appliance LDAP cluster configuration.\n#### Purpose\nIt provides system-managed insight into the LDAP integration topology associated with an IdP.\n#### Key Concepts\n- **Connector Inventory:** Lists internal connector names for an LDAP cluster.\n- **IdP Linkage:** Tied to the corresponding LDAP IdP domain.\n- **System-managed:** Created and maintained by internal services.\n- **Operational Visibility:** Aids diagnostics and lifecycle management.", "x-allOf-name": "iam.LdapMeta", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapMeta" ], "default": "iam.LdapMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapMeta" ], "default": "iam.LdapMeta", "x-enum-as-string": true }, "Connectors": { "type": "array", "items": { "description": "The list of internal ldap dex connectors created by the system for an Ldap server cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Domain": { "description": "The domain of the Ldap IdP corresponding to the appliance Ldap configuration.", "type": "string", "readOnly": true, "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.LdapMeta.List": { "title": "List of 'iam.LdapMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapMeta" }, "nullable": true } } } ] }, "iam.LdapPolicy.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapPolicy' resources.", "x-one-of-name": "iam.LdapPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapPolicy.Relationship": { "description": "A relationship to the 'iam.LdapPolicy' resource, or the expanded 'iam.LdapPolicy' resource, or the 'null' value.", "x-one-of-name": "iam.LdapPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapPolicy": { "title": "LDAP", "description": "### Overview\nThe LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication for endpoints like servers and chassis.\n#### Purpose\nThe primary purpose of an LDAP Policy is to integrate endpoints with a central directory service (like Microsoft Active Directory or OpenLDAP) for user authentication. This centralizes user management and allows administrators to grant access to Intersight-managed devices based on existing corporate directory groups and users, rather than creating separate local accounts on each device.\n#### Key Concepts\n- **Centralized Authentication:** - Enables endpoints to authenticate users against one or more external LDAP servers.\n- **Reusable and Profile-Based:** - As a policy object, this provides a standardized LDAP configuration that can be applied to multiple server or chassis profiles.\n- **Flexible Configuration:** - Supports various settings including the Base DN for searches, bind methods (Anonymous, Configured Credentials, Login Credentials), and connection settings like encryption and timeout.\n- **Group-to-Role Mapping:** - Works with LdapGroup objects to map directory groups to local endpoint roles, enabling granular, role-based access control for remote users.\n- **Provider and DNS Settings:** - Manages a list of LDAP servers (LdapProvider objects) and can be configured to use DNS for server discovery.", "x-allOf-name": "iam.LdapPolicy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapPolicy" ], "default": "iam.LdapPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapPolicy" ], "default": "iam.LdapPolicy", "x-enum-as-string": true }, "BaseProperties": { "description": "Base settings of LDAP required while configuring LDAP policy.", "$ref": "#/components/schemas/iam.LdapBaseProperties", "x-omitempty": true }, "DnsParameters": { "description": "Configuration settings to resolve LDAP servers, when DNS is enabled.", "$ref": "#/components/schemas/iam.LdapDnsParameters", "x-omitempty": true }, "EnableDns": { "description": "Enables DNS to access LDAP servers.", "type": "boolean", "x-omitempty": true }, "Enabled": { "description": "LDAP server performs authentication.", "type": "boolean", "default": true, "x-omitempty": true }, "UserSearchPrecedence": { "description": "Search precedence between local user database and LDAP user database.\n* `LocalUserDb` - Precedence is given to local user database while searching.\n* `LDAPUserDb` - Precedence is given to LADP user database while searching.", "type": "string", "enum": [ "LocalUserDb", "LDAPUserDb" ], "default": "LocalUserDb", "x-omitempty": true }, "ApplianceAccount": { "$ref": "#/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." }, "Groups": { "description": "An array of relationships to iamLdapGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapGroup.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/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": "#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true }, "Providers": { "description": "An array of relationships to iamLdapProvider resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapProvider.Relationship" }, "nullable": true, "x-createOnly": true } } } ] }, "iam.LdapPolicy.List": { "title": "List of 'iam.LdapPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapPolicy" }, "nullable": true } } } ] }, "iam.LdapPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapPolicyInventory' resources.", "x-one-of-name": "iam.LdapPolicyInventory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapPolicyInventory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapPolicyInventory.Relationship": { "description": "A relationship to the 'iam.LdapPolicyInventory' resource, or the expanded 'iam.LdapPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "iam.LdapPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapPolicyInventory": { "title": "LDAP", "description": "### Overview\nThe LDAP Policy object is a reusable policy for configuring Lightweight Directory Access Protocol (LDAP) settings, enabling remote user authentication for endpoints like servers and chassis.\n#### Purpose\nThe primary purpose of an LDAP Policy is to integrate endpoints with a central directory service (like Microsoft Active Directory or OpenLDAP) for user authentication. This centralizes user management and allows administrators to grant access to Intersight-managed devices based on existing corporate directory groups and users, rather than creating separate local accounts on each device.\n#### Key Concepts\n- **Centralized Authentication:** - Enables endpoints to authenticate users against one or more external LDAP servers.\n- **Reusable and Profile-Based:** - As a policy object, this provides a standardized LDAP configuration that can be applied to multiple server or chassis profiles.\n- **Flexible Configuration:** - Supports various settings including the Base DN for searches, bind methods (Anonymous, Configured Credentials, Login Credentials), and connection settings like encryption and timeout.\n- **Group-to-Role Mapping:** - Works with LdapGroup objects to map directory groups to local endpoint roles, enabling granular, role-based access control for remote users.\n- **Provider and DNS Settings:** - Manages a list of LDAP servers (LdapProvider objects) and can be configured to use DNS for server discovery.", "x-allOf-name": "iam.LdapPolicyInventory", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapPolicyInventory" ], "default": "iam.LdapPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapPolicyInventory" ], "default": "iam.LdapPolicyInventory", "x-enum-as-string": true }, "BaseProperties": { "description": "Base settings of LDAP required while configuring LDAP policy.", "$ref": "#/components/schemas/iam.LdapBaseProperties", "readOnly": true, "x-omitempty": true }, "DnsParameters": { "description": "Configuration settings to resolve LDAP servers, when DNS is enabled.", "$ref": "#/components/schemas/iam.LdapDnsParameters", "readOnly": true, "x-omitempty": true }, "EnableDns": { "description": "Enables DNS to access LDAP servers.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "LDAP server performs authentication.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "UserSearchPrecedence": { "description": "Search precedence between local user database and LDAP user database.\n* `LocalUserDb` - Precedence is given to local user database while searching.\n* `LDAPUserDb` - Precedence is given to LADP user database while searching.", "type": "string", "enum": [ "LocalUserDb", "LDAPUserDb" ], "default": "LocalUserDb", "readOnly": true, "x-omitempty": true }, "Groups": { "description": "An array of relationships to iamLdapGroupInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapGroupInventory.Relationship" }, "nullable": true, "readOnly": true }, "Providers": { "description": "An array of relationships to iamLdapProviderInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapProviderInventory.Relationship" }, "nullable": true, "readOnly": true }, "TargetMo": { "$ref": "#/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 } } } ] }, "iam.LdapPolicyInventory.List": { "title": "List of 'iam.LdapPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapPolicyInventory" }, "nullable": true } } } ] }, "iam.LdapProvider.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapProvider' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapProvider' resources.", "x-one-of-name": "iam.LdapProvider.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapProvider.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapProvider.Relationship": { "description": "A relationship to the 'iam.LdapProvider' resource, or the expanded 'iam.LdapProvider' resource, or the 'null' value.", "x-one-of-name": "iam.LdapProvider.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapProvider" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapProvider": { "title": "Iam:Ldap Provider", "description": "### Overview\nThe LDAP Provider object represents a single LDAP server that an endpoint will use for authentication. It is a component of an LdapPolicy.\n#### Purpose\nThe purpose is to define the connection details for one LDAP server. An LdapPolicy can contain a list of LdapProvider objects, creating an ordered list of servers that the endpoint will attempt to contact for authentication.\n#### Key Concepts\n- **Server Endpoint:** - Specifies the IP address or hostname and the port of the LDAP server.\n- **Component of a Policy:** - It does not function independently but is always part of an LdapPolicy.\n- **Ordered List:** - The order of LdapProvider objects within the policy determines the failover sequence for authentication attempts.", "x-allOf-name": "iam.LdapProvider", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapProvider', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapProvider" ], "default": "iam.LdapProvider", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapProvider" ], "default": "iam.LdapProvider", "x-enum-as-string": true }, "Port": { "description": "LDAP Server Port for connection establishment.", "type": "integer", "format": "int64", "default": 389, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "Server": { "description": "LDAP Server Address, such as an IP address or hostname.", "type": "string", "x-omitempty": true }, "Vendor": { "description": "LDAP server vendor type used for authentication.\n* `OpenLDAP` - Open source LDAP server for remote authentication.\n* `MSAD` - Microsoft active directory for remote authentication.", "type": "string", "enum": [ "OpenLDAP", "MSAD" ], "default": "OpenLDAP", "x-omitempty": true }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicy.Relationship", "description": "A reference to a iamLdapPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.LdapProvider.List": { "title": "List of 'iam.LdapProvider' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapProvider' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapProvider' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapProvider" }, "nullable": true } } } ] }, "iam.LdapProviderInventory.Response": { "description": "The response body of a HTTP GET request for the 'iam.LdapProviderInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LdapProviderInventory' resources.", "x-one-of-name": "iam.LdapProviderInventory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LdapProviderInventory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LdapProviderInventory.Relationship": { "description": "A relationship to the 'iam.LdapProviderInventory' resource, or the expanded 'iam.LdapProviderInventory' resource, or the 'null' value.", "x-one-of-name": "iam.LdapProviderInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LdapProviderInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LdapProviderInventory": { "title": "Iam:Ldap Provider Inventory", "description": "### Overview\nThe LDAP Provider object represents a single LDAP server that an endpoint will use for authentication. It is a component of an LdapPolicy.\n#### Purpose\nThe purpose is to define the connection details for one LDAP server. An LdapPolicy can contain a list of LdapProvider objects, creating an ordered list of servers that the endpoint will attempt to contact for authentication.\n#### Key Concepts\n- **Server Endpoint:** - Specifies the IP address or hostname and the port of the LDAP server.\n- **Component of a Policy:** - It does not function independently but is always part of an LdapPolicy.\n- **Ordered List:** - The order of LdapProvider objects within the policy determines the failover sequence for authentication attempts.", "x-allOf-name": "iam.LdapProviderInventory", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LdapProviderInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LdapProviderInventory" ], "default": "iam.LdapProviderInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LdapProviderInventory" ], "default": "iam.LdapProviderInventory", "x-enum-as-string": true }, "Port": { "description": "LDAP Server Port for connection establishment.", "type": "integer", "format": "int64", "default": 389, "minimum": 1, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "Server": { "description": "LDAP Server Address, such as an IP address or hostname.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "LDAP server vendor type used for authentication.\n* `OpenLDAP` - Open source LDAP server for remote authentication.\n* `MSAD` - Microsoft active directory for remote authentication.", "type": "string", "enum": [ "OpenLDAP", "MSAD" ], "default": "OpenLDAP", "readOnly": true, "x-omitempty": true }, "LdapPolicy": { "$ref": "#/components/schemas/iam.LdapPolicyInventory.Relationship", "description": "A reference to a iamLdapPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.LdapProviderInventory.List": { "title": "List of 'iam.LdapProviderInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LdapProviderInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LdapProviderInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LdapProviderInventory" }, "nullable": true } } } ] }, "iam.LocalUserPassword.Response": { "description": "The response body of a HTTP GET request for the 'iam.LocalUserPassword' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LocalUserPassword' resources.", "x-one-of-name": "iam.LocalUserPassword.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LocalUserPassword.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LocalUserPassword.Relationship": { "description": "A relationship to the 'iam.LocalUserPassword' resource, or the expanded 'iam.LocalUserPassword' resource, or the 'null' value.", "x-one-of-name": "iam.LocalUserPassword.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.LocalUserPassword" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.LocalUserPassword": { "title": "Iam:Local User Password", "description": "LocalUserPassword provides the mechanism for a local user to change their own password within the platform appliance context. This model is applicable only to Intersight Appliance deployments.\n#### Purpose\nIt enforces secure password-change operations for local users while keeping reset flows separate.\n#### Key Concepts\n- **Self-service Change:** Allows users to update their own password.\n- **Policy-aware:** Works alongside password policy configurations.\n- **Scoped to User:** Inherits permissions from the associated user.\n- **Appliance Focus:** Applicable to local authentication scenarios.", "x-allOf-name": "iam.LocalUserPassword", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LocalUserPassword', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LocalUserPassword" ], "default": "iam.LocalUserPassword", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LocalUserPassword" ], "default": "iam.LocalUserPassword", "x-enum-as-string": true }, "CurrentPassword": { "description": "User-entered password to be compared to password for change password function.", "type": "string", "writeOnly": true, "x-omitempty": true }, "InitialPassword": { "description": "Initial password set for the local user for the first time when the local user gets created or when the password gets reset by the Account Administrator.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsCurrentPasswordSet": { "description": "Indicates whether the value of the 'currentPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsInitialPasswordSet": { "description": "Indicates whether the value of the 'initialPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsNewPasswordSet": { "description": "Indicates whether the value of the 'newPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "NeedPasswordReset": { "description": "Indicates whether the user should be prompted to reset their password.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "NewPassword": { "description": "New password that the user's password should be changed to.", "type": "string", "writeOnly": true, "x-omitempty": true }, "PasswordExpiresInDays": { "description": "The passwordExpiresInDays attribute indicates the number of days remaining until a user's password expires,\nwith negative values meaning the password has already expired and zero indicating expiration today.\nThis value is dynamically calculated based on the time since the last password change and the maximum\nallowed password age defined by the password policy. No migration code or default value is required\nduring system upgrades because the value is computed in real-time, and initially, the password age\nproperty defaults to zero, ensuring no passwords are mistakenly marked as expired.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "User": { "$ref": "#/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 } } } ] }, "iam.LocalUserPassword.List": { "title": "List of 'iam.LocalUserPassword' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LocalUserPassword' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LocalUserPassword' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LocalUserPassword" }, "nullable": true } } } ] }, "iam.LocalUserPasswordPolicy.Response": { "description": "The response body of a HTTP GET request for the 'iam.LocalUserPasswordPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.LocalUserPasswordPolicy' resources.", "x-one-of-name": "iam.LocalUserPasswordPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.LocalUserPasswordPolicy": { "title": "Iam:Local User Password Policy", "description": "LocalUserPasswordPolicy defines the password complexity and lockout policy for local users within an account.\n#### Purpose\nIt establishes compliance and security requirements for local user credentials.\n#### Key Concepts\n- **Complexity Rules:** Configures length, character requirements, and reuse constraints.\n- **Lockout Behavior:** Sets thresholds and lock durations for failed logins.\n- **Admin-governed:** Managed by authorized roles in the account.\n- **Consistent Enforcement:** Applies to all local user password operations.", "x-allOf-name": "iam.LocalUserPasswordPolicy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.LocalUserPasswordPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.LocalUserPasswordPolicy" ], "default": "iam.LocalUserPasswordPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.LocalUserPasswordPolicy" ], "default": "iam.LocalUserPasswordPolicy", "x-enum-as-string": true }, "EnableLockOutForAdminUser": { "description": "Determines if the user lock out feature must be enabled for the local admin user.", "type": "boolean", "default": false, "x-omitempty": true }, "FailedLoginTrackerWindow": { "description": "The duration, in seconds, within which consecutive incorrect login attempts are counted. The system locks out the account if the number of incorrect attempts exceeds the maximum allowed value during this window.", "type": "integer", "format": "int64", "default": 1800, "minimum": 300, "maximum": 3600, "x-omitempty": true }, "LockOutTimePeriod": { "description": "The time period, in seconds, during which a user account will remain locked.", "type": "integer", "format": "int64", "default": 900, "minimum": 60, "maximum": 3600, "x-omitempty": true }, "MaxDaysAllowedWithSamePassword": { "description": "Maximum number of days a password can be used before it must be changed. Set to 0 to disable password expiration.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 3650, "x-omitempty": true }, "MaxFailedLoginsAllowed": { "description": "Users will be locked out after exceeding the max consecutive incorrect login attempts allowed within the configured time duration.", "type": "integer", "format": "int64", "default": 5, "minimum": 3, "maximum": 10, "x-omitempty": true }, "MinCharDifference": { "description": "Minimum number of characters different from previous password.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 15, "x-omitempty": true }, "MinDaysBetweenPasswordChange": { "description": "Minimum Days allowed between password change.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 7, "x-omitempty": true }, "MinLengthPassword": { "description": "Minimum length of password.", "type": "integer", "format": "int64", "default": 8, "minimum": 8, "maximum": 127, "x-omitempty": true }, "MinLowerCase": { "description": "Minimum number of required lower case characters.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 64, "x-omitempty": true }, "MinNumeric": { "description": "Minimum number of required numeric characters.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 64, "x-omitempty": true }, "MinSpecialChar": { "description": "Minimum number of required special characters.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 64, "x-omitempty": true }, "MinUpperCase": { "description": "Minimum number of required upper case characters.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 64, "x-omitempty": true }, "NumPreviousPasswordsDisallowed": { "description": "Number of previous passwords disallowed.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 10, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "iam.LocalUserPasswordPolicy.List": { "title": "List of 'iam.LocalUserPasswordPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.LocalUserPasswordPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.LocalUserPasswordPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.LocalUserPasswordPolicy" }, "nullable": true } } } ] }, "iam.OAuthToken.Response": { "description": "The response body of a HTTP GET request for the 'iam.OAuthToken' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.OAuthToken' resources.", "x-one-of-name": "iam.OAuthToken.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.OAuthToken.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.OAuthToken.Relationship": { "description": "A relationship to the 'iam.OAuthToken' resource, or the expanded 'iam.OAuthToken' resource, or the 'null' value.", "x-one-of-name": "iam.OAuthToken.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.OAuthToken" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.OAuthToken": { "title": "OAuth2 Token", "description": "The meta data for generating OAuth2 token of a user.\nIt is created when user logged in via OAuth2 using Authorization Code grant\nand deleted upon logout, expiration timeout or manual deletion.", "x-allOf-name": "iam.OAuthToken", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.OAuthToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.OAuthToken" ], "default": "iam.OAuthToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.OAuthToken" ], "default": "iam.OAuthToken", "x-enum-as-string": true }, "AccessExpirationTime": { "description": "Expiration time for the JWT token to which it can be used for api calls.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ClientId": { "description": "The identifier of the registered application to which the token belongs.", "type": "string", "x-omitempty": true }, "ClientIpAddress": { "description": "The user agent IP address from which the auth token is launched.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClientName": { "description": "The name of the registered application to which the token belongs.", "type": "string", "x-omitempty": true }, "ExpirationTime": { "description": "Expiration time for the JWT token to which it can be refreshed.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastLoginClient": { "description": "The client address from which last login is initiated.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastLoginTime": { "description": "The last login time for user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "TokenId": { "description": "Token identifier. Not the Access Token itself.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserMeta": { "description": "User Device meta information.", "$ref": "#/components/schemas/iam.ClientMeta", "x-omitempty": true }, "AppRegistration": { "$ref": "#/components/schemas/iam.AppRegistration.Relationship", "description": "A reference to a iamAppRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/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 } } } ] }, "iam.OAuthToken.List": { "title": "List of 'iam.OAuthToken' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.OAuthToken' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.OAuthToken' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.OAuthToken" }, "nullable": true } } } ] }, "iam.OidcAuthTokenSet": { "title": "Iam:Oidc Auth Token Set", "description": "Holds attributes obtained after OIDC authentication in plain text which are required for CUI admin portal MFE \ninside Intersight for IdP settings and routing rules, session refresh and logout functionality. Used during \naccount creation when encryption is not yet possible, as the encryption token is only available after account \ncreation. These tokens are stored in clear text only for the login session in which the account is being created.", "x-allOf-name": "iam.OidcAuthTokenSet", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "iam.PasswordHistorySetting": { "title": "Iam:Password History Setting", "description": "Password history settings for endpoint users.", "x-allOf-name": "iam.PasswordHistorySetting", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PasswordHistorySetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PasswordHistorySetting" ], "default": "iam.PasswordHistorySetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PasswordHistorySetting" ], "default": "iam.PasswordHistorySetting", "x-enum-as-string": true }, "HistoryIndex": { "description": "Index of the next passwordHistory collection.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "LastModificationTime": { "description": "Time when the password was last modified.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "PasswordHistory": { "type": "array", "items": { "description": "Password history for the user.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Username": { "description": "User for which this password history is applicable.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iam.PasswordHistorySettingCollection.Response": { "description": "The response body of a HTTP GET request for the 'iam.PasswordHistorySettingCollection' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.PasswordHistorySettingCollection' resources.", "x-one-of-name": "iam.PasswordHistorySettingCollection.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.PasswordHistorySettingCollection.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.PasswordHistorySettingCollection": { "title": "Iam:Password History Setting Collection", "description": "The PasswordHistorySettingCollection object is a centralized management entity designed to track and enforce password history across the system. It addresses the challenges of maintaining consistent password policies in distributed server environments.\n#### Purpose\nThe primary purpose of this object is to eliminate inconsistencies that occur when password history is managed at the individual server level. By centralizing this data, the system can reliably prevent the reuse of previous passwords, regardless of which policy or server the user is interacting with.\n#### Key Concepts\n- **Centralized Enforcement:** Moves password history logic from individual endpoints to a central collection, ensuring uniform enforcement across the account.\n- **Scalability:** Avoids the performance and storage issues associated with local history tracking on hardware endpoints.\n- **Lifecycle Awareness:** Includes mechanisms to identify \"orphaned\" history records when associated policies or servers are deleted, ensuring data hygiene.\n- **Cross-Object Relationships:** Links password history to accounts, profiles, policies, and physical servers to provide a holistic view of user security.", "x-allOf-name": "iam.PasswordHistorySettingCollection", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PasswordHistorySettingCollection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PasswordHistorySettingCollection" ], "default": "iam.PasswordHistorySettingCollection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PasswordHistorySettingCollection" ], "default": "iam.PasswordHistorySettingCollection", "x-enum-as-string": true }, "Orphaned": { "description": "Orphaned indicates whether policy, server or profile changed or deleted related to this object. Such objects would be marked as orphaned for deletion.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "PasswordHistoryObjects": { "type": "array", "items": { "description": "Collection of PasswordHistorySetting objects.", "$ref": "#/components/schemas/iam.PasswordHistorySetting", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PasswordHistoryWindow": { "description": "The password history window size (number of previous passwords to remember) that is currently in effect. Used to detect policy changes at deploy time so the stored history can be renormalized if the window has changed.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Policy": { "$ref": "#/components/schemas/iam.EndPointUserPolicy.Relationship", "description": "A reference to a iamEndPointUserPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Profile": { "$ref": "#/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 }, "Server": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/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 } } } ] }, "iam.PasswordHistorySettingCollection.List": { "title": "List of 'iam.PasswordHistorySettingCollection' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.PasswordHistorySettingCollection' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.PasswordHistorySettingCollection' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PasswordHistorySettingCollection" }, "nullable": true } } } ] }, "iam.Permission.Response": { "description": "The response body of a HTTP GET request for the 'iam.Permission' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Permission' resources.", "x-one-of-name": "iam.Permission.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Permission.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Permission.Relationship": { "description": "A relationship to the 'iam.Permission' resource, or the expanded 'iam.Permission' resource, or the 'null' value.", "x-one-of-name": "iam.Permission.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Permission" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Permission": { "title": "Role", "description": "Permission provides a way to assign roles to a user or user group to perform operations on object hierarchy.", "x-allOf-name": "iam.Permission", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Permission', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Permission" ], "default": "iam.Permission", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Permission" ], "default": "iam.Permission", "x-enum-as-string": true }, "Description": { "description": "The informative description about each permission.", "type": "string", "minLength": 0, "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "The name of the permission which has to be granted to user.", "type": "string", "pattern": "^[a-zA-Z0-9_ .:-]{1,128}$", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "EndPointRoles": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true }, "ResourceRoles": { "description": "An array of relationships to iamResourceRoles resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourceRoles.Relationship" }, "nullable": true, "x-createOnly": true }, "Roles": { "deprecated": true, "x-sunset": "2027-03-01", "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true }, "SessionLimits": { "$ref": "#/components/schemas/iam.SessionLimits.Relationship", "description": "A reference to a iamSessionLimits resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "UserGroups": { "description": "An array of relationships to iamUserGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup.Relationship" }, "nullable": true }, "Users": { "description": "An array of relationships to iamUser resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User.Relationship" }, "nullable": true } } } ] }, "iam.Permission.List": { "title": "List of 'iam.Permission' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Permission' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Permission' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Permission" }, "nullable": true } } } ] }, "iam.PermissionReference": { "title": "Iam:Permission Reference", "description": "Users can log in through the base URL (https://intersight.com) or account-specific URLs. When the Intersight user logs in through the base URL, Intersight identifies the accounts and permissions within each account which the user has access to. In case multiple permissions are identified, the user and session objects are created in the onboarding-user account, and the session object is updated with account and permission information. Intersight GUI uses this information to show available accounts and permissions for the user to select. PermissionReference type is used to store permission information of an account.", "x-allOf-name": "iam.PermissionReference", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PermissionReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PermissionReference" ], "default": "iam.PermissionReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PermissionReference" ], "default": "iam.PermissionReference", "x-enum-as-string": true }, "PermissionIdentifier": { "description": "MOID of the permission which user has access to.", "type": "string", "readOnly": true, "x-omitempty": true }, "PermissionName": { "description": "Name of the permission which user has access to.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserGroupMappings": { "type": "array", "items": { "description": "Moids of the user groups which grant this permission to the user.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.PermissionToRoles": { "title": "Iam:Permission To Roles", "description": "Complex type representing a permission and its associated roles.", "x-allOf-name": "iam.PermissionToRoles", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PermissionToRoles', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PermissionToRoles" ], "default": "iam.PermissionToRoles", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PermissionToRoles" ], "default": "iam.PermissionToRoles", "x-enum-as-string": true }, "Permission": { "description": "Permission Id of the object.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "PrivilegeSets": { "type": "array", "items": { "description": "Collection of PrivilegeSets for the Permission.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Roles": { "type": "array", "items": { "description": "Collection of Roles for the Permission.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.PrivateKeySpec.Response": { "description": "The response body of a HTTP GET request for the 'iam.PrivateKeySpec' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.PrivateKeySpec' resources.", "x-one-of-name": "iam.PrivateKeySpec.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.PrivateKeySpec.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.PrivateKeySpec.Relationship": { "description": "A relationship to the 'iam.PrivateKeySpec' resource, or the expanded 'iam.PrivateKeySpec' resource, or the 'null' value.", "x-one-of-name": "iam.PrivateKeySpec.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.PrivateKeySpec" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.PrivateKeySpec": { "title": "Iam:Private Key Spec", "description": "PrivateKeySpec defines parameters for generating a private key that will be used to sign a certificate signing request (CSR).\n#### Purpose\nIt standardizes the key generation process for certificate workflows.\n#### Key Concepts\n- **CSR Workflow:** Couples key generation with a certificate request.\n- **Algorithm Selection:** Encapsulates key algorithm and parameters.\n- **Scoped Inheritance:** Governed by the associated certificate request.\n- **Security Posture:** Ensures consistent, policy-aligned key creation.", "x-allOf-name": "iam.PrivateKeySpec", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PrivateKeySpec', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PrivateKeySpec" ], "default": "iam.PrivateKeySpec", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PrivateKeySpec" ], "default": "iam.PrivateKeySpec", "x-enum-as-string": true }, "Algorithm": { "description": "Algorithm used to generate the key pair and algorithm-speicifc parameters, such as RSA modulus size.", "$ref": "#/components/schemas/pkix.KeyGenerationSpec", "x-createOnly": true, "x-omitempty": true }, "CertificateRequest": { "$ref": "#/components/schemas/iam.CertificateRequest.Relationship", "description": "A reference to a iamCertificateRequest resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "iam.PrivateKeySpec.List": { "title": "List of 'iam.PrivateKeySpec' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.PrivateKeySpec' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.PrivateKeySpec' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivateKeySpec" }, "nullable": true } } } ] }, "iam.Privilege.Response": { "description": "The response body of a HTTP GET request for the 'iam.Privilege' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Privilege' resources.", "x-one-of-name": "iam.Privilege.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Privilege.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Privilege.Relationship": { "description": "A relationship to the 'iam.Privilege' resource, or the expanded 'iam.Privilege' resource, or the 'null' value.", "x-one-of-name": "iam.Privilege.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Privilege" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Privilege": { "title": "Iam:Privilege", "description": "Privilege represents an action which can be performed in Intersight such as creating server profile, deleting a user etc.", "x-allOf-name": "iam.Privilege", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Privilege', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Privilege" ], "default": "iam.Privilege", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Privilege" ], "default": "iam.Privilege", "x-enum-as-string": true }, "AttributeNames": { "type": "array", "items": { "description": "The list of attribute names associated with a conditional privilege. When the condition is met, access is granted to update these specific attributes.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Condition": { "description": "The condition expression or criteria that determines when this conditional privilege can grant access to update the specified attribute names.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Informative description about each privilege.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostnamePrefix": { "description": "The hostname prefix of the resource corresponding to this privilege. For example \\'sentry\\' in https://sentry.intersight.com .", "type": "string", "readOnly": true, "x-omitempty": true }, "IsConditionalPrivilege": { "description": "Flag that indicates whether this privilege is conditional.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Method": { "description": "The API method on the rest resource corresponding to privilege. For example READ, CREATE, UPDATE etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the privilege reported by microservice.", "type": "string", "readOnly": true, "x-omitempty": true }, "RestPath": { "description": "The REST API path of the resource corresponding to this privilege. For example /v1/iam/Accounts, /v1/iam/Sessions.", "type": "string", "readOnly": true, "x-omitempty": true }, "UrlPrefix": { "description": "The URL path prefix of the resource corresponding to this privilege. For example /devops/kibana, /devops/grafana etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.Privilege.List": { "title": "List of 'iam.Privilege' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Privilege' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Privilege' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Privilege" }, "nullable": true } } } ] }, "iam.PrivilegeSet.Response": { "description": "The response body of a HTTP GET request for the 'iam.PrivilegeSet' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.PrivilegeSet' resources.", "x-one-of-name": "iam.PrivilegeSet.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.PrivilegeSet.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.PrivilegeSet.Relationship": { "description": "A relationship to the 'iam.PrivilegeSet' resource, or the expanded 'iam.PrivilegeSet' resource, or the 'null' value.", "x-one-of-name": "iam.PrivilegeSet.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.PrivilegeSet" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.PrivilegeSet": { "title": "Iam:Privilege Set", "description": "A collection of privileges.", "x-allOf-name": "iam.PrivilegeSet", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PrivilegeSet', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PrivilegeSet" ], "default": "iam.PrivilegeSet", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PrivilegeSet" ], "default": "iam.PrivilegeSet", "x-enum-as-string": true }, "AllowFutureUpdates": { "description": "Flag used by UI to keep track of the user selection option for future updates of privilege sets.", "type": "boolean", "default": true, "x-omitempty": true }, "Description": { "description": "Description of the privilege set.", "type": "string", "x-omitempty": true }, "IsPrivilegeNamesUpdated": { "description": "Flag to indicate if the privilege names are updated.", "type": "boolean", "default": false, "x-omitempty": true }, "Name": { "description": "Name of the privilege set.", "type": "string", "pattern": "^[a-zA-Z0-9_ .:,()&/-]{1,128}$", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "PrivilegeNames": { "type": "array", "items": { "description": "Names of the privileges in the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PrivilegeSetType": { "description": "Type of the privilege set.\n* `Internal` - Privilege set is internal to the system.\n* `SystemPackaged` - Privilege set is packaged by the system and user can use it as a reference for custom privilege set creation.\n* `SystemDefined` - Privilege set is defined by the system.\n* `TreeNode` - Privilege set is a tree node in the custom privilege set creation hierarchy.\n* `TreeRoot` - Privilege set is a tree root in the custom privilege set creation hierarchy.\n* `TreeLeaf` - Privilege set is a tree leaf in the custom privilege set creation hierarchy.\n* `UserCreated` - Privilege set is created by the user.", "type": "string", "enum": [ "Internal", "SystemPackaged", "SystemDefined", "TreeNode", "TreeRoot", "TreeLeaf", "UserCreated" ], "default": "Internal", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "The scope of the privilege set.\n* `Generic` - Privilege set can be added to account wide permission or organization permissions.\n* `Account` - Privilege set can be added to account wide permission only.", "type": "string", "enum": [ "Generic", "Account" ], "default": "Generic", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "UUID of the privilege set.", "type": "string", "pattern": "^[a-zA-Z0-9_ .:,-]{0,128}$", "minLength": 0, "maxLength": 128, "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "AssociatedPrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true }, "Privileges": { "description": "An array of relationships to iamPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Privilege.Relationship" }, "nullable": true, "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.PrivilegeSet.List": { "title": "List of 'iam.PrivilegeSet' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.PrivilegeSet' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.PrivilegeSet' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet" }, "nullable": true } } } ] }, "iam.PrivilegeSetMetaInfo.Response": { "description": "The response body of a HTTP GET request for the 'iam.PrivilegeSetMetaInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.PrivilegeSetMetaInfo' resources.", "x-one-of-name": "iam.PrivilegeSetMetaInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.PrivilegeSetMetaInfo": { "title": "Iam:Privilege Set Meta Info", "description": "PrivilegeSetMetaInfo centralizes metadata to validate, relate, and maintain privilege sets. It captures the context needed to evaluate dependencies and associations, ensuring consistency with access policies.\n#### Purpose\nPrivilegeSetMetaInfo validates privilege sets before persistence by tracking upstream and downstream relationships. It identifies missing dependencies and surfaces insights to ensure secure, confident design.\n#### Key Concepts\n- **Dependency Intelligence:** Continuously analyzes privilege-set relationships to reveal required, computed, and missing dependencies, helping teams remediate gaps before deployment.\n- **Association Awareness:** Maintains links between related privilege sets, providing a holistic view of how access models interact within broader governance frameworks.\n- **Validation-First Workflow:** Operates as a non-persistent validation layer, allowing privilege configurations to be assessed, iterated, and approved before becoming part of the active system.\n- **Access Governance Alignment:** Integrates with defined privilege sets and management roles to ensure only authorized stakeholders can inspect or adjust metadata, supporting least-privilege best practices.", "x-allOf-name": "iam.PrivilegeSetMetaInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.PrivilegeSetMetaInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.PrivilegeSetMetaInfo" ], "default": "iam.PrivilegeSetMetaInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.PrivilegeSetMetaInfo" ], "default": "iam.PrivilegeSetMetaInfo", "x-enum-as-string": true }, "AllDependencyInfo": { "description": "All dependency information of the privilege set.", "nullable": true, "readOnly": true, "x-omitempty": true }, "AssociatedPrivilegeSetNames": { "type": "array", "items": { "description": "The names of the privilege sets associated with this metadata.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DownstreamDependencies": { "type": "array", "items": { "description": "Downstream dependencies of the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MissingDependencyInfo": { "description": "Missing dependency information of the privilege set.", "nullable": true, "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpstreamDependencies": { "type": "array", "items": { "description": "Upstream dependencies of the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Uuid": { "description": "UUID of the privilege set.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssociatedPrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true }, "MissingPrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.PrivilegeSetMetaInfo.List": { "title": "List of 'iam.PrivilegeSetMetaInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.PrivilegeSetMetaInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.PrivilegeSetMetaInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSetMetaInfo" }, "nullable": true } } } ] }, "iam.Qualifier.Response": { "description": "The response body of a HTTP GET request for the 'iam.Qualifier' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Qualifier' resources.", "x-one-of-name": "iam.Qualifier.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Qualifier.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Qualifier": { "title": "Iam:Qualifier", "description": "The qualifier defines how a user qualifies to be part of a user group.", "x-allOf-name": "iam.Qualifier", "allOf": [ { "$ref": "#/components/schemas/iam.AbstractQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Qualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Qualifier" ], "default": "iam.Qualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Qualifier" ], "default": "iam.Qualifier", "x-enum-as-string": true }, "Name": { "description": "The name of the SAML attribute used to qualify a user to user group. By default this is memberOf attribute in SAML assertion.", "type": "string", "readOnly": true, "x-omitempty": true }, "Value": { "type": "array", "items": { "description": "The value of the SAML attribute.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "iam.Qualifier.List": { "title": "List of 'iam.Qualifier' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Qualifier' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Qualifier' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Qualifier" }, "nullable": true } } } ] }, "iam.ResourceLimits.Response": { "description": "The response body of a HTTP GET request for the 'iam.ResourceLimits' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ResourceLimits' resources.", "x-one-of-name": "iam.ResourceLimits.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ResourceLimits.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ResourceLimits.Relationship": { "description": "A relationship to the 'iam.ResourceLimits' resource, or the expanded 'iam.ResourceLimits' resource, or the 'null' value.", "x-one-of-name": "iam.ResourceLimits.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ResourceLimits" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ResourceLimits": { "title": "Iam:Resource Limits", "description": "ResourceLimits establishes account-level limits and policies for identity-related resources and credentials.\n#### Purpose\nIt ensures controlled growth and predictable operational parameters for users and machine credentials.\n#### Key Concepts\n- **User Caps:** Governs the maximum number of users per account.\n- **Credential Lifecycles:** Defines expiration policies for API keys and app registrations.\n- **Exceptions Policy:** Controls whether non-expiring credentials are allowed.\n- **Broad Readability:** Exposed to multiple roles for visibility and governance.", "x-allOf-name": "iam.ResourceLimits", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ResourceLimits', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ResourceLimits" ], "default": "iam.ResourceLimits", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ResourceLimits" ], "default": "iam.ResourceLimits", "x-enum-as-string": true }, "AllowApiKeysWithoutExpiry": { "description": "Boolean value used to decide whether API keys that never expire are allowed for the account. This allows creation of API keys which are perpetual which can used for specific applications where rotation of API keys are not feasible.", "type": "boolean", "default": false, "x-omitempty": true }, "AllowAppRegistrationsWithoutExpiry": { "description": "Boolean value used to decide whether App Registration that never expire are allowed for the account.", "type": "boolean", "default": false, "x-omitempty": true }, "MaxApiKeyExpiry": { "description": "The maximum expiration period (in seconds) allowed for API keys. The default value is 180 days or 15552000 seconds. It is shown to user in days for readability.", "type": "integer", "format": "int64", "default": 15552000, "minimum": 0, "maximum": 31104000, "x-omitempty": true }, "MaxAppRegistrationExpiry": { "description": "The maximum expiration period (in seconds) allowed for App Registration. The default value is 180 days or 15552000 seconds. It is shown to user in days for readability.", "type": "integer", "format": "int64", "default": 15552000, "minimum": 0, "maximum": 31104000, "x-omitempty": true }, "PerAccountUserLimit": { "description": "The maximum number of users allowed in an account. The default value is 200.", "type": "integer", "format": "int64", "minimum": 1, "maximum": 200, "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "iam.ResourceLimits.List": { "title": "List of 'iam.ResourceLimits' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ResourceLimits' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ResourceLimits' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourceLimits" }, "nullable": true } } } ] }, "iam.ResourcePermission.Response": { "description": "The response body of a HTTP GET request for the 'iam.ResourcePermission' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ResourcePermission' resources.", "x-one-of-name": "iam.ResourcePermission.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ResourcePermission.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ResourcePermission.Relationship": { "description": "A relationship to the 'iam.ResourcePermission' resource, or the expanded 'iam.ResourcePermission' resource, or the 'null' value.", "x-one-of-name": "iam.ResourcePermission.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ResourcePermission" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ResourcePermission": { "title": "Iam:Resource Permission", "description": "ResourcePermission represents the permissions defined on a resource like organization.", "x-allOf-name": "iam.ResourcePermission", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ResourcePermission', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ResourcePermission" ], "default": "iam.ResourcePermission", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ResourcePermission" ], "default": "iam.ResourcePermission", "x-enum-as-string": true }, "PermissionRoles": { "type": "array", "items": { "description": "Permissions which are associated with the organization and their role mapping.", "$ref": "#/components/schemas/iam.PermissionToRoles", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetApp": { "description": "Name of the service owning the resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Holder": { "$ref": "#/components/schemas/iam.SecurityHolder.Relationship", "description": "A reference to a iamSecurityHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "#/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 } } } ] }, "iam.ResourcePermission.List": { "title": "List of 'iam.ResourcePermission' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ResourcePermission' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ResourcePermission' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourcePermission" }, "nullable": true } } } ] }, "iam.ResourceRole": { "title": "Iam:Resource Role", "description": "ResourceRoles provides a way to specify the roles associated with a resource like organization.", "x-allOf-name": "iam.ResourceRole", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "iam.ResourceRoles.Response": { "description": "The response body of a HTTP GET request for the 'iam.ResourceRoles' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ResourceRoles' resources.", "x-one-of-name": "iam.ResourceRoles.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ResourceRoles.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ResourceRoles.Relationship": { "description": "A relationship to the 'iam.ResourceRoles' resource, or the expanded 'iam.ResourceRoles' resource, or the 'null' value.", "x-one-of-name": "iam.ResourceRoles.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ResourceRoles" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ResourceRoles": { "title": "Iam:Resource Roles", "description": "ResourceRoles maps roles to a specific resource (e.g., an organization) within a permission, shaping the effective access model.\n#### Purpose\nIt provides fine-grained control over which roles apply to which resources for a given permission.\n#### Key Concepts\n- **Resource-scoped Roles:** Tailors access at the resource boundary.\n- **Role Composition:** Works with roles, privilege sets, and endpoint roles.\n- **Permission-centric:** Operates within a permission\u2019s assignment context.\n- **Flexible Governance:** Enables nuanced, resource-level authorization design.", "x-allOf-name": "iam.ResourceRoles", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ResourceRoles', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ResourceRoles" ], "default": "iam.ResourceRoles", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ResourceRoles" ], "default": "iam.ResourceRoles", "x-enum-as-string": true }, "EndPointRoles": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true }, "Resource": { "$ref": "#/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.", "x-createOnly": true }, "Roles": { "deprecated": true, "x-sunset": "2027-03-01", "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true } } } ] }, "iam.ResourceRoles.List": { "title": "List of 'iam.ResourceRoles' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ResourceRoles' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ResourceRoles' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourceRoles" }, "nullable": true } } } ] }, "iam.Role.Response": { "description": "The response body of a HTTP GET request for the 'iam.Role' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.Role' resources.", "x-one-of-name": "iam.Role.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Role.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Role.Relationship": { "description": "A relationship to the 'iam.Role' resource, or the expanded 'iam.Role' resource, or the 'null' value.", "x-one-of-name": "iam.Role.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Role" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Role": { "title": "Iam:Role", "description": "A role is a collection of privilege sets that are assigned to a user using a permission object.", "x-allOf-name": "iam.Role", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Role', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Role" ], "default": "iam.Role", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Role" ], "default": "iam.Role", "x-enum-as-string": true }, "Description": { "description": "Informative description about each role.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the role which has to be granted to user.", "type": "string", "pattern": "^[a-zA-Z0-9_ .:-]{1,64}$", "minLength": 1, "maxLength": 64, "x-createOnly": true, "x-omitempty": true }, "PrivilegeNames": { "type": "array", "items": { "description": "Names of the privileges in the role.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Account": { "$ref": "#/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 }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true, "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.Role.List": { "title": "List of 'iam.Role' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.Role' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.Role' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role" }, "nullable": true } } } ] }, "iam.Rule": { "title": "Iam:Rule", "description": "Rule stores the information about the IP address. This information is used during the IP address\nvalidation of the incoming request.", "x-allOf-name": "iam.Rule", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.Rule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.Rule" ], "default": "iam.Rule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.Rule" ], "default": "iam.Rule", "x-enum-as-string": true }, "IpV6": { "description": "The flag represents if IP addresses in the rule is IPv4 or IPv6.", "type": "boolean", "x-omitempty": true }, "RuleType": { "description": "The type of the IP address. Currently three types are supported, ie IP, CIDR range and IP range.\n* `Ip` - The IP address rule type is IP.\n* `Cidr` - The IP address rule type is CIDR range.\n* `IpRange` - The IP address rule type is IP range.", "type": "string", "enum": [ "Ip", "Cidr", "IpRange" ], "default": "Ip", "x-omitempty": true }, "RuleValue": { "type": "array", "items": { "description": "The rule value stores the IP address/es.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "iam.SamlSpConnection": { "title": "Iam:Saml Sp Connection", "description": "SamlSpConnection stores the metadata elements.", "x-allOf-name": "iam.SamlSpConnection", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SamlSpConnection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SamlSpConnection" ], "default": "iam.SamlSpConnection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SamlSpConnection" ], "default": "iam.SamlSpConnection", "x-enum-as-string": true }, "IdentityProviderSloBinding": { "description": "SingleLogout Services binding in IdP Metadata.", "type": "string", "x-omitempty": true }, "IdentityProviderSloUrl": { "description": "SingleLogOut Services location in IdP Metadata.", "type": "string", "x-omitempty": true }, "IdentityProviderSsoBinding": { "description": "SingleSignOn Services binding in IdP Metadata.", "type": "string", "x-omitempty": true }, "IdentityProviderSsoUrl": { "description": "SingleSignOn Services location in IdP Metadata.", "type": "string", "x-omitempty": true }, "IdpCertificateStore": { "description": "Decoded Certificate from IdP Metatdata.", "nullable": true, "x-omitempty": true }, "SignAuthnRequests": { "description": "WantAuthnRequestsSigned from IdP Metadata.", "type": "boolean", "x-omitempty": true } } } ] }, "iam.SecurityContext": { "title": "Iam:Security Context", "description": "Complex type representing the access related properties of the requesting entity, required for authorization. Entity can be NB API user, a device, another micro service or a 3rd party client requesting access to Intersight's APIs.", "x-allOf-name": "iam.SecurityContext", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "iam.SecurityHolder.Response": { "description": "The response body of a HTTP GET request for the 'iam.SecurityHolder' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.SecurityHolder' resources.", "x-one-of-name": "iam.SecurityHolder.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.SecurityHolder.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.SecurityHolder.Relationship": { "description": "A relationship to the 'iam.SecurityHolder' resource, or the expanded 'iam.SecurityHolder' resource, or the 'null' value.", "x-one-of-name": "iam.SecurityHolder.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.SecurityHolder" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.SecurityHolder": { "title": "Iam:Security Holder", "description": "SecurityHolder aggregates account-wide and organization-scoped permissions, serving as the nexus for effective authorization state across the accounts resource hierarchy.\n#### Purpose\nSecurityHolder centralizes derived permissions and related controls like IP access management for consistent policy enforcement.\n#### Key Concepts\n- **Aggregated Permissions:** Collects effective permissions per resource (organization).\n- **Policy Container:** Anchors resource-permission mappings for authorization checks.\n- **Access Governance:** Hosts IP-based access management settings for the account.\n- **Account Integration:** Bound to the accounts overall security structure.", "x-allOf-name": "iam.SecurityHolder", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SecurityHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SecurityHolder" ], "default": "iam.SecurityHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SecurityHolder" ], "default": "iam.SecurityHolder", "x-enum-as-string": true }, "Account": { "$ref": "#/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 }, "IpRulesConfiguration": { "$ref": "#/components/schemas/iam.IpAccessManagement.Relationship", "description": "A reference to a iamIpAccessManagement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ResourcePermissions": { "description": "An array of relationships to iamResourcePermission resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ResourcePermission.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.SecurityHolder.List": { "title": "List of 'iam.SecurityHolder' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.SecurityHolder' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.SecurityHolder' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.SecurityHolder" }, "nullable": true } } } ] }, "iam.ServiceProvider.Response": { "description": "The response body of a HTTP GET request for the 'iam.ServiceProvider' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.ServiceProvider' resources.", "x-one-of-name": "iam.ServiceProvider.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.ServiceProvider.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.ServiceProvider.Relationship": { "description": "A relationship to the 'iam.ServiceProvider' resource, or the expanded 'iam.ServiceProvider' resource, or the 'null' value.", "x-one-of-name": "iam.ServiceProvider.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.ServiceProvider" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.ServiceProvider": { "title": "Iam:Service Provider", "description": "ServiceProvider encapsulates the platforms SAML Service Provider (SP) identity and metadata, used to integrate with external IdPs.\n#### Purpose\nIt provides SP metadata for administrators to configure their IdPs to trust and federate with the platform.\n#### Key Concepts\n- **SP Identity:** Exposes canonical entity identifiers and metadata.\n- **Integrator-facing:** Consumed by admins setting up external SSO.\n- **Read-only:** Ensures the consistency of official SP materials.\n- **Trust Foundation:** Essential for secure federation with IdPs.", "x-allOf-name": "iam.ServiceProvider", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.ServiceProvider', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.ServiceProvider" ], "default": "iam.ServiceProvider", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.ServiceProvider" ], "default": "iam.ServiceProvider", "x-enum-as-string": true }, "EntityId": { "description": "Entity ID of the Intersight Service Provider. In SAML, the entity ID uniquely identifies the IdP/Service Provider.", "type": "string", "readOnly": true, "x-omitempty": true }, "Metadata": { "description": "Metadata of the Intersight Service Provider. User downloads the Intersight Service Provider metadata and integrates it with their IdP for authentication.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the Intersight Service Provider.", "type": "string", "readOnly": true, "x-omitempty": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.ServiceProvider.List": { "title": "List of 'iam.ServiceProvider' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.ServiceProvider' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.ServiceProvider' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ServiceProvider" }, "nullable": true } } } ] }, "iam.Session.Response": { "description": "The response body of a HTTP GET request for the 'iam.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 'iam.Session' resources.", "x-one-of-name": "iam.Session.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.Session.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.Session.Relationship": { "description": "A relationship to the 'iam.Session' resource, or the expanded 'iam.Session' resource, or the 'null' value.", "x-one-of-name": "iam.Session.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.Session" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.Session": { "title": "Iam:Session", "description": "The web session of a user. After a user logs into Intersight, a session object is created. Session object is deleted upon logout, idle timeout, expiry timeout, or manual deletion.", "x-allOf-name": "iam.Session", "allOf": [ { "$ref": "#/components/schemas/session.AbstractSession" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.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": [ "iam.Session" ], "default": "iam.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": [ "iam.Session" ], "default": "iam.Session", "x-enum-as-string": true }, "AccountPermissions": { "type": "array", "items": { "description": "The accounts and the permissions within each account which a user can select after authentication. After authentication if user has access to multiple permissions, then user and session object are created in onboarding user account and asked to select one of these permissions.", "$ref": "#/components/schemas/iam.AccountPermissions", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Expiration": { "description": "Expiration time for the session.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "FailedLogins": { "description": "Failed logins since last login for admin user.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IdleTimeExpiration": { "description": "Idle time expiration for the session.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastLoginClient": { "description": "The client address from which last login is initiated.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastLoginTime": { "description": "The last login time for user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LoginType": { "description": "The type of login that created this session. Indicates whether the session was created through standard web login or JWT token exchange.\n* `weblogin` - Session created through standard web login process.\n* `tokenexchange` - Session created through JWT token exchange process.", "type": "string", "enum": [ "weblogin", "tokenexchange" ], "default": "weblogin", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "Scope holds a collection of account Id, permission Id to which the current session is scoped to.", "$ref": "#/components/schemas/iam.SwitchScopePermissions", "readOnly": true, "x-omitempty": true }, "SessionId": { "description": "Session token shared with the user agent which is used to identify the user session when API requests are received to perform authorization.", "type": "string", "x-omitempty": true }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "#/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 } } } ] }, "iam.Session.List": { "title": "List of 'iam.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.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 'iam.Session' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Session" }, "nullable": true } } } ] }, "iam.SessionLimits.Response": { "description": "The response body of a HTTP GET request for the 'iam.SessionLimits' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.SessionLimits' resources.", "x-one-of-name": "iam.SessionLimits.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.SessionLimits.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.SessionLimits.Relationship": { "description": "A relationship to the 'iam.SessionLimits' resource, or the expanded 'iam.SessionLimits' resource, or the 'null' value.", "x-one-of-name": "iam.SessionLimits.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.SessionLimits" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.SessionLimits": { "title": "Iam:Session Limits", "description": "The session related configuration limits.", "x-allOf-name": "iam.SessionLimits", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SessionLimits', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SessionLimits" ], "default": "iam.SessionLimits", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SessionLimits" ], "default": "iam.SessionLimits", "x-enum-as-string": true }, "IdleTimeOut": { "description": "The idle timeout interval for the web session in seconds. When a session is not refreshed for this duration, the session is marked as idle and removed. The minimum value is 300 seconds and the maximum value is 18000 seconds (5 hours). The system default value is 1800 seconds.", "type": "integer", "format": "int64", "default": 1800, "minimum": 300, "maximum": 18000, "x-omitempty": true }, "MaximumLimit": { "description": "The maximum number of sessions allowed in an account or permission. The default value is 128.", "type": "integer", "format": "int64", "default": 128, "minimum": 1, "maximum": 128, "x-omitempty": true }, "PerUserLimit": { "description": "The maximum number of sessions allowed per user. Default value is 32.", "type": "integer", "format": "int64", "default": 32, "minimum": 2, "maximum": 32, "x-omitempty": true }, "SessionTimeOut": { "description": "The session expiry duration in seconds. The minimum value is 350 seconds and the maximum value is 31536000 seconds (1 year). The system default value is 57600 seconds.", "type": "integer", "format": "int64", "default": 57600, "minimum": 300, "maximum": 31536000, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Permission": { "$ref": "#/components/schemas/iam.Permission.Relationship", "description": "A reference to a iamPermission resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.SessionLimits.List": { "title": "List of 'iam.SessionLimits' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.SessionLimits' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.SessionLimits' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.SessionLimits" }, "nullable": true } } } ] }, "iam.SharingRule.Response": { "description": "The response body of a HTTP GET request for the 'iam.SharingRule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.SharingRule' resources.", "x-one-of-name": "iam.SharingRule.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.SharingRule.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.SharingRule.Relationship": { "description": "A relationship to the 'iam.SharingRule' resource, or the expanded 'iam.SharingRule' resource, or the 'null' value.", "x-one-of-name": "iam.SharingRule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.SharingRule" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.SharingRule": { "title": "Iam:Sharing Rule", "description": "SharingRule is a rule which signifies a Source Resource is shared with a Destination Resource. Source, Destination can be resources like Organization which are supported in role configuration. The objects created in Source can be referenced by the objects of Destination.", "x-allOf-name": "iam.SharingRule", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SharingRule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SharingRule" ], "default": "iam.SharingRule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SharingRule" ], "default": "iam.SharingRule", "x-enum-as-string": true }, "Account": { "$ref": "#/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 }, "SharedResource": { "$ref": "#/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.", "x-createOnly": true }, "SharedWithResource": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "iam.SharingRule.List": { "title": "List of 'iam.SharingRule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.SharingRule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.SharingRule' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.SharingRule" }, "nullable": true } } } ] }, "iam.SsoSessionAttributes": { "title": "Iam:Sso Session Attributes", "description": "Session attributes required to maintain states of SP and IdP.", "x-allOf-name": "iam.SsoSessionAttributes", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SsoSessionAttributes', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SsoSessionAttributes" ], "default": "iam.SsoSessionAttributes", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SsoSessionAttributes" ], "default": "iam.SsoSessionAttributes", "x-enum-as-string": true }, "AllowSwitchRoleOrAccount": { "description": "Captures if the user is allowed to switch roles or accounts after login and is used by UI to show/hide Switch Role Or Account option. It is set to true when Intersight identifies that the user has multiple roles or accounts during login based on user attributes and Intersight account IAM configuration. For IdP initiated SSO logins, this field is always set to false. Any changes to user roles or accounts after a session is created will not change this field. If switch role/account option is selected, user is re-authenticated with IdP and user roles and accounts are identified and AllowSwitchRoleOrAccount property is updated accordingly.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IdpSessionExpiration": { "description": "SAML SessionNotOnOrAfter attribute sent by IdP in the assertion. IdP uses this to control for how long SP session maybe. SP does not issue SLO if the session is not valid.", "type": "string", "readOnly": true, "x-omitempty": true }, "IdpSessionIndex": { "description": "SAML SessionIndex attribute sent by IdP in the assertion. This has to be sent back to IdP in LogoutRequest.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsIdpInitiatedSso": { "description": "Sign-in is SP-Intitiated or IdP-Intitiated.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsPartialAccountsListed": { "description": "Select Account Page shows partial list of accounts when processing data from some regions fails.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SubjectName": { "description": "SAML Subject NameID attribute sent by IdP in the assertion. This has to be sent back to IdP in LogoutRequest.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iam.SwitchAccountPermission": { "title": "Iam:Switch Account Permission", "description": "SwitchScope parameters related to the Account to/from which user switched.", "x-allOf-name": "iam.SwitchAccountPermission", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SwitchAccountPermission', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SwitchAccountPermission" ], "default": "iam.SwitchAccountPermission", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SwitchAccountPermission" ], "default": "iam.SwitchAccountPermission", "x-enum-as-string": true }, "AccountId": { "description": "Moid of the Account to/from which user switched the scope.", "type": "string", "readOnly": true, "x-omitempty": true }, "PermissionId": { "description": "Moid of the Permission for the Account to/from which user switched the scope.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "iam.SwitchScopePermissions": { "title": "Iam:Switch Scope Permissions", "description": "SwitchScope parameters related to the Account to which user switched to.", "x-allOf-name": "iam.SwitchScopePermissions", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.SwitchScopePermissions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.SwitchScopePermissions" ], "default": "iam.SwitchScopePermissions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.SwitchScopePermissions" ], "default": "iam.SwitchScopePermissions", "x-enum-as-string": true }, "AccountAccessControlId": { "description": "Moid of the AccountAccessControl through which the access is given to switch scope.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestIdentifier": { "description": "Stores the identifier of the issue for which user is trying to switch scope to another account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SwitchedFromAccount": { "description": "Permission for the Account from which user switched the scope.", "$ref": "#/components/schemas/iam.SwitchAccountPermission", "readOnly": true, "x-omitempty": true }, "SwitchedToAccounts": { "type": "array", "items": { "description": "Collection of Accounts to which user switched the scope.", "$ref": "#/components/schemas/iam.SwitchAccountPermission", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "iam.System.Response": { "description": "The response body of a HTTP GET request for the 'iam.System' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.System' resources.", "x-one-of-name": "iam.System.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.System.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.System.Relationship": { "description": "A relationship to the 'iam.System' resource, or the expanded 'iam.System' resource, or the 'null' value.", "x-one-of-name": "iam.System.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.System" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.System": { "title": "Iam:System", "description": "The System object is the global root within the platform, serving as a container for objects that are shared across all accounts. It centralizes platform-wide security constructs, such as privileges, privilege sets, and roles, as well as the default identity provider and service provider configuration.\n#### Purpose\nSystem provides a consistent, read-only global context from which account-scoped security and access models are derived and referenced.\n#### Key Concepts\n- **Global Scope:** Hosts objects that are common and reusable across all accounts.\n- **Security Model Anchor:** Aggregates privilege sets, privileges, and roles available platform-wide.\n- **Identity Foundation:** Holds the default identity provider and service provider definitions.\n- **Read-only Access:** Ensures integrity of shared security constructs.", "x-allOf-name": "iam.System", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.System', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.System" ], "default": "iam.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.", "enum": [ "iam.System" ], "default": "iam.System", "x-enum-as-string": true }, "EndPointPrivileges": { "description": "An array of relationships to iamEndPointPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointPrivilege.Relationship" }, "nullable": true, "readOnly": true }, "EndPointRoles": { "description": "An array of relationships to iamEndPointRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.EndPointRole.Relationship" }, "nullable": true, "readOnly": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PrivilegeSets": { "description": "An array of relationships to iamPrivilegeSet resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.PrivilegeSet.Relationship" }, "nullable": true, "readOnly": true }, "Privileges": { "description": "An array of relationships to iamPrivilege resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Privilege.Relationship" }, "nullable": true, "readOnly": true }, "Roles": { "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true, "readOnly": true }, "ServiceProvider": { "$ref": "#/components/schemas/iam.ServiceProvider.Relationship", "description": "A reference to a iamServiceProvider resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "iam.System.List": { "title": "List of 'iam.System' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.System' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.System' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.System" }, "nullable": true } } } ] }, "iam.TenantLinking": { "title": "Iam:Tenant Linking", "description": "Contains tenant linking information for CUI and CCC integration.", "x-allOf-name": "iam.TenantLinking", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.TenantLinking', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.TenantLinking" ], "default": "iam.TenantLinking", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.TenantLinking" ], "default": "iam.TenantLinking", "x-enum-as-string": true }, "Product": { "description": "The product name for the tenant linking (e.g., CUI, CCC).", "type": "string", "x-omitempty": true }, "TenantId": { "description": "The tenant ID for the linked product.", "type": "string", "x-omitempty": true } } } ] }, "iam.TestIdpConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'iam.TestIdpConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.TestIdpConfiguration' resources.", "x-one-of-name": "iam.TestIdpConfiguration.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.TestIdpConfiguration.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.TestIdpConfiguration.Relationship": { "description": "A relationship to the 'iam.TestIdpConfiguration' resource, or the expanded 'iam.TestIdpConfiguration' resource, or the 'null' value.", "x-one-of-name": "iam.TestIdpConfiguration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.TestIdpConfiguration" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.TestIdpConfiguration": { "title": "Iam:Test Idp Configuration", "description": "TestIdpConfiguration supports validating an IdP setup by performing a controlled authentication, currently supported only for testing LDAP configurations. test and capturing outcomes.\n#### Purpose\nIt helps administrators verify IdP integration parameters and diagnose configuration issues before production use.\n#### Key Concepts\n- **Validation Utility:** Initiates a test flow against the configured IdP.\n- **Diagnostic Feedback:** Provides success status and error details.\n- **Readiness Signal:** Confirms correctness of protocol and mapping settings.\n- **Admin Tool:** Designed for identity administrators managing SSO.", "x-allOf-name": "iam.TestIdpConfiguration", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.TestIdpConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.TestIdpConfiguration" ], "default": "iam.TestIdpConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.TestIdpConfiguration" ], "default": "iam.TestIdpConfiguration", "x-enum-as-string": true }, "ErrorDetails": { "description": "Error returned by the IdP when the configuration test fails.", "type": "string", "readOnly": true, "x-omitempty": true }, "IdpEntityId": { "description": "Entity ID of the IdP whose configuration needs to be tested.", "type": "string", "readOnly": true, "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 }, "NoOfGroups": { "description": "Total number of groups of the user received from the IdP after successful authentication.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Password": { "description": "The password of the test user for testing the IdP configuration settings. It can be any string that adheres to the following constraints. It can have character except spaces, tabs, line breaks. It cannot be more than 256 characters.", "type": "string", "pattern": "^$|^\\S{3,256}$", "writeOnly": true, "x-omitempty": true }, "Status": { "description": "IdP configuration test result.\n* `Unverified` - The IdP configuration is yet to be verified.\n* `Verified` - Successfully authenticated the user via the configured IdP and verified the configuration parameters.\n* `Pending` - Pending verification of the IdP configuration.\n* `Failed` - Could not authenticate the user via the configured IdP and verify its configuration.", "type": "string", "enum": [ "Unverified", "Verified", "Pending", "Failed" ], "default": "Unverified", "readOnly": true, "x-omitempty": true }, "TriggerTest": { "description": "Trigger property used to initiate an IdP configuration test.", "type": "boolean", "x-omitempty": true }, "Username": { "description": "Email or userId of the test user for testing the IdP configuration settings.", "type": "string", "pattern": "^$|^(?:[a-zA-Z0-9._-]{3,256}|[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 }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.TestIdpConfiguration.List": { "title": "List of 'iam.TestIdpConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.TestIdpConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.TestIdpConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.TestIdpConfiguration" }, "nullable": true } } } ] }, "iam.TrustPoint.Response": { "description": "The response body of a HTTP GET request for the 'iam.TrustPoint' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.TrustPoint' resources.", "x-one-of-name": "iam.TrustPoint.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.TrustPoint.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.TrustPoint.Relationship": { "description": "A relationship to the 'iam.TrustPoint' resource, or the expanded 'iam.TrustPoint' resource, or the 'null' value.", "x-one-of-name": "iam.TrustPoint.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.TrustPoint" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.TrustPoint": { "title": "Iam:Trust Point", "description": "The TrustPoint object represents a trusted source of certificates within the system, enabling secure communication and authentication.\n#### Purpose\nA TrustPoint serves as a repository for certificates, affirming the identity of trusted entities and facilitating secure interactions with external systems.\n#### Key Concepts\n- **Certificate Management:** Stores and manages X.509 certificates, supporting both root and intermediate certificates for authentication purposes.\n- **Security Assurance:** Provides a basis for secure communication by validating the identity of external entities through trusted certificates.\n- **Account Association:** Associates certificates with specific accounts, ensuring they are available for authentication within the account's scope.\n- **Certificate Import:** Allows the import of third-party certificates, enhancing security through integration with external certificate authorities.", "x-allOf-name": "iam.TrustPoint", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.TrustPoint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.TrustPoint" ], "default": "iam.TrustPoint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.TrustPoint" ], "default": "iam.TrustPoint", "x-enum-as-string": true }, "Certificates": { "type": "array", "items": { "description": "The collection of certificates in X509 certificate format.\nThis was obtained by parsing the chain property which holds the base 64 encoded chain of certificates.", "$ref": "#/components/schemas/x509.Certificate", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Chain": { "description": "The certificate information for this trusted point. The certificate must be in Base64 encoded X.509 (CER) format.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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 }, "AssignedToEntity": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.TrustPoint.List": { "title": "List of 'iam.TrustPoint' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.TrustPoint' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.TrustPoint' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.TrustPoint" }, "nullable": true } } } ] }, "iam.User.Response": { "description": "The response body of a HTTP GET request for the 'iam.User' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.User' resources.", "x-one-of-name": "iam.User.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.User.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.User.Relationship": { "description": "A relationship to the 'iam.User' resource, or the expanded 'iam.User' resource, or the 'null' value.", "x-one-of-name": "iam.User.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.User" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.User": { "title": "User", "description": "The User object represents individual users within the system, encompassing their identity, permissions, and roles.\n#### Purpose\nA User is a central entity within the system, defining the attributes, and roles associated with an individual accessing the system. It enables personalized and secure interactions with the system's resources.\n #### Key Concepts\n - **Identity Management:** Maintains user identification details, including name, email, and unique identifiers, for authentication and authorization purposes.\n - **Role Assignment:** Associates users with roles, defining their access levels and capabilities within the system.\n - **Session Tracking:** Tracks user sessions, providing insights into login activity and enabling session management features.\n - **Security Controls:** Implements security measures such as password policies and account lockout features, ensuring user accounts are protected against unauthorized access.", "x-allOf-name": "iam.User", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.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": [ "iam.User" ], "default": "iam.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": [ "iam.User" ], "default": "iam.User", "x-enum-as-string": true }, "ClientIpAddress": { "description": "IP address from which the user last logged in to Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "Email": { "description": "Email of the user. Remote users are added to Intersight using the email configured in the IdP.", "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-createOnly": true, "x-omitempty": true }, "ExternalIdentifier": { "description": "External identifier for the user, used for integration with external identity systems.", "type": "string", "x-omitempty": true }, "FirstName": { "description": "First name of the user. For remote users, this field is populated from the IdP attributes received after authentication.", "type": "string", "x-omitempty": true }, "LastLoginTime": { "description": "Last successful login time for user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastName": { "description": "Last name of the user. For remote users, this field is populated from the IdP attributes received after authentication.", "type": "string", "x-omitempty": true }, "LastRoleModifiedTime": { "description": "Last role modification time for user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LockedUntil": { "description": "Time until which the user account will be locked out.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the user. For remote users, it is the value as configured in the IdP.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserIdOrEmail": { "description": "UserID or email of the user. For remote users, it is the value as configured in the IDP.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "UserType": { "description": "Type of the User. If a user is added manually by specifying the email address, or has logged in using groups, based on the IdP attributes received during authentication. If added manually, the user type will be static, otherwise dynamic.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserUniqueIdentifier": { "description": "Unique id of the user used by the identity provider to store the user.", "type": "string", "readOnly": true, "x-omitempty": true }, "ApiKeys": { "description": "An array of relationships to iamApiKey resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.ApiKey.Relationship" }, "nullable": true, "readOnly": true }, "AppRegistrations": { "description": "An array of relationships to iamAppRegistration resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.AppRegistration.Relationship" }, "nullable": true, "readOnly": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Idpreference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LocalUserPassword": { "$ref": "#/components/schemas/iam.LocalUserPassword.Relationship", "description": "A reference to a iamLocalUserPassword resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OauthTokens": { "description": "An array of relationships to iamOAuthToken resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.OAuthToken.Relationship" }, "nullable": true, "readOnly": true }, "Permissions": { "description": "An array of relationships to iamPermission resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Permission.Relationship" }, "nullable": true }, "Sessions": { "description": "An array of relationships to iamSession resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Session.Relationship" }, "nullable": true, "readOnly": true }, "Usergroup": { "description": "An array of relationships to iamUserGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.User.List": { "title": "List of 'iam.User' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.User' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.User' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User" }, "nullable": true } } } ] }, "iam.UserDetails": { "title": "Iam:User Details", "description": "Holds information such as UserName and Email of a guest user logging in to the account.", "x-allOf-name": "iam.UserDetails", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserDetails" ], "default": "iam.UserDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserDetails" ], "default": "iam.UserDetails", "x-enum-as-string": true }, "EmailNotificationStatus": { "description": "Stores the information on whether user has been sent an email about access details or not.\n* `NotSent` - The Account Admin might not choose send email notification to any of their guest users.\n* `Sent` - An email notification sent to notified users who are configured per guest access link.", "type": "string", "enum": [ "NotSent", "Sent" ], "default": "NotSent", "readOnly": true, "x-omitempty": true }, "UserEmail": { "description": "Stores the user email ID of the guest user.", "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])?)*$", "minLength": 4, "maxLength": 320, "x-omitempty": true }, "UserName": { "description": "Stores the user name of the guest user.", "type": "string", "minLength": 0, "maxLength": 500, "x-omitempty": true } } } ] }, "iam.UserGroup.Response": { "description": "The response body of a HTTP GET request for the 'iam.UserGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.UserGroup' resources.", "x-one-of-name": "iam.UserGroup.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.UserGroup.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.UserGroup.Relationship": { "description": "A relationship to the 'iam.UserGroup' resource, or the expanded 'iam.UserGroup' resource, or the 'null' value.", "x-one-of-name": "iam.UserGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.UserGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.UserGroup": { "title": "Iam:User Group", "description": "UserGroup provides a policy mechanism to assign permissions to cohorts of users based on identity attributes or explicit guest inclusion.\n#### Purpose\nUserGroup simplifies access management by mapping identity attributes (or guest lists) to permissions at scale.\n#### Key Concepts\n- **Attribute-based Access:** Qualifies users into groups using IdP attributes.\n- **Guest Access Mode:** Supports time-bound, link-based access for guest users.\n- **Permission Binding:** Assigns roles and privileges via permissions to the group.\n- **Lifecycle Governance:** Tracks activation/expiry for guest access scenarios.", "x-allOf-name": "iam.UserGroup", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserGroup" ], "default": "iam.UserGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserGroup" ], "default": "iam.UserGroup", "x-enum-as-string": true }, "AccessActivationTime": { "description": "AccessActivationTime indicates the activation time for the guest user's access to the Account. Before this time, if guest user tries to login to the account, access the account will be denied.", "type": "string", "format": "date-time", "x-omitempty": true }, "AccessExpiryTime": { "description": "AccessExpiryTime indicates the expiration time for the guest user's access to the Account. Its value can only be assigned a date that falls within the range determined by the maximum expiration time configured for the API entries. The AccessExpiry date can be edited to be earlier or later.", "type": "string", "format": "date-time", "x-omitempty": true }, "AccessLink": { "description": "AccessLink using which the guest user uses to log in to Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "GroupType": { "description": "Group type determines the type of groups that is being associated with users. By default, Default User group will be used for associating dynamic user login. If the value of the User Group is set to guest, then this type of user group will be used for guest user login.\n* `Default` - Default User Group Type used for dynamic users login.\n* `Guest` - Guest User Group type used for guest users login.", "type": "string", "enum": [ "Default", "Guest" ], "default": "Default", "x-omitempty": true }, "Instruction": { "description": "Instruction property holds detailed guidance and information intended for individuals accessing the system as guest users. It holds the information to assist guests in navigating the platform, understanding policies, and performing necessary actions to ensure a seamless and secure user experience.", "type": "string", "maxLength": 2048, "x-omitempty": true }, "Name": { "description": "The name of the user group which the dynamic/or guest user belongs to.", "type": "string", "minLength": 1, "maxLength": 2048, "x-omitempty": true }, "UniqueReferenceId": { "description": "A random mixed character string which is unique per user groups. UniqueReferenceId is used as key for identifying the guest user groups.", "type": "string", "readOnly": true, "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Idpreference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Permissions": { "description": "An array of relationships to iamPermission resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Permission.Relationship" }, "nullable": true }, "Qualifier": { "$ref": "#/components/schemas/iam.AbstractQualifier.Relationship", "description": "A reference to a iamAbstractQualifier resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Users": { "description": "An array of relationships to iamUser resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.User.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iam.UserGroup.List": { "title": "List of 'iam.UserGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.UserGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.UserGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserGroup" }, "nullable": true } } } ] }, "iam.UserPreference.Response": { "description": "The response body of a HTTP GET request for the 'iam.UserPreference' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.UserPreference' resources.", "x-one-of-name": "iam.UserPreference.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.UserPreference.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.UserPreference.Relationship": { "description": "A relationship to the 'iam.UserPreference' resource, or the expanded 'iam.UserPreference' resource, or the 'null' value.", "x-one-of-name": "iam.UserPreference.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.UserPreference" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.UserPreference": { "title": "Iam:User Preference", "description": "UserPreference captures user interface preferences\u2014such as layout, view state, or theme\u2014persisted per user and identity context.\n#### Purpose\nIt enables consistent, personalized UI experiences across sessions and devices.\n#### Key Concepts\n- **Per-user Configuration:** Bound to a user and IdP/IdP reference context.\n- **Shared Resource:** Accessible across organizations where applicable.\n- **Self-service Updates:** Users can read and update their preferences.\n- **UI-centric:** Focused on client experience, not authorization.", "x-allOf-name": "iam.UserPreference", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserPreference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserPreference" ], "default": "iam.UserPreference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserPreference" ], "default": "iam.UserPreference", "x-enum-as-string": true }, "Preference": { "description": "UI preferences of the user.", "nullable": true, "x-omitempty": true }, "UserUniqueIdentifier": { "description": "Unique id of the user used by the identity provider to store the user.", "type": "string", "readOnly": true, "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IdpReference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.UserPreference.List": { "title": "List of 'iam.UserPreference' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.UserPreference' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.UserPreference' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserPreference" }, "nullable": true } } } ] }, "iam.UserQualifier.Response": { "description": "The response body of a HTTP GET request for the 'iam.UserQualifier' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.UserQualifier' resources.", "x-one-of-name": "iam.UserQualifier.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.UserQualifier.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.UserQualifier": { "title": "Iam:User Qualifier", "description": "UserQualifier specifies explicit guest user lists for a guest-type UserGroup and supports notification flows.\n#### Purpose\nIt streamlines management of guest access by enumerating allowed users and automating communication to them.\n#### Key Concepts\n- **Explicit Inclusion:** Lists guest users for controlled access.\n- **Notification Control:** Supports emailing access details to users.\n- **Guest Lifecycle:** Aligns with group activation and expiry.\n- **Group-bound:** Functions in the context of a guest user group.", "x-allOf-name": "iam.UserQualifier", "allOf": [ { "$ref": "#/components/schemas/iam.AbstractQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserQualifier" ], "default": "iam.UserQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserQualifier" ], "default": "iam.UserQualifier", "x-enum-as-string": true }, "LastNotificationTime": { "description": "Holds the information on when last email notification was sent to the guest users.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "NotificationScope": { "description": "Defines the scope of email notifications for guest users. It determines which guest users should receive email notifications about account access details. Options include notifying all users or only newly added users.\n* `All` - Email Notification is sent to all users.\n* `New` - Email Notification is sent to newly added users.", "type": "string", "enum": [ "All", "New" ], "default": "All", "x-omitempty": true }, "NotifyGuestUsers": { "description": "NotifyGuestUsers holds information on whether guest users have been notified about the guest access information. If set to true, all guest users will receive a email notification about the details of guest access link and instructions.", "type": "boolean", "x-omitempty": true }, "UserDetails": { "type": "array", "items": { "description": "Stores the guest user details.", "$ref": "#/components/schemas/iam.UserDetails", "x-omitempty": true }, "nullable": true } } } ] }, "iam.UserQualifier.List": { "title": "List of 'iam.UserQualifier' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.UserQualifier' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.UserQualifier' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserQualifier" }, "nullable": true } } } ] }, "iam.UserSetting.Response": { "description": "The response body of a HTTP GET request for the 'iam.UserSetting' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iam.UserSetting' resources.", "x-one-of-name": "iam.UserSetting.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iam.UserSetting.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iam.UserSetting.Relationship": { "description": "A relationship to the 'iam.UserSetting' resource, or the expanded 'iam.UserSetting' resource, or the 'null' value.", "x-one-of-name": "iam.UserSetting.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iam.UserSetting" } ], "discriminator": { "propertyName": "ClassId" } }, "iam.UserSetting": { "title": "Iam:User Setting", "description": "UserSetting stores specific UI-related settings that are not part of general preferences, such as session recording opt-in status.\n#### Purpose\nIt allows storing discrete user settings that drive UI features and compliance preferences.\n#### Key Concepts\n- **Fine-grained Settings:** Captures individual flags or controls.\n- **Per-user Scope:** Stored per user and IdP/IdP reference context.\n- **Complementary to Preferences:** Designed for settings distinct from bulk UI preferences.\n- **Self-managed:** Users can create and update their own settings.", "x-allOf-name": "iam.UserSetting", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iam.UserSetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iam.UserSetting" ], "default": "iam.UserSetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iam.UserSetting" ], "default": "iam.UserSetting", "x-enum-as-string": true }, "AllowUiSessionRecording": { "description": "UI preference of the user for Session Recording.", "type": "boolean", "default": true, "x-omitempty": true }, "DefaultPermission": { "type": "array", "items": { "description": "Stores the shared default permission selection for all supported login interfaces. Eligible CUI IdpReference users must retain a valid default permission entry once they have at least one allowed permission in the tenant.", "$ref": "#/components/schemas/iam.DefaultPermissionInfo", "x-omitempty": true }, "nullable": true }, "UserIdOrEmail": { "description": "UserID or email as configured in the IdP.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserUniqueIdentifier": { "description": "Unique id of the user used by the identity provider to store the user.", "type": "string", "readOnly": true, "x-omitempty": true }, "Idp": { "$ref": "#/components/schemas/iam.Idp.Relationship", "description": "A reference to a iamIdp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IdpReference": { "$ref": "#/components/schemas/iam.IdpReference.Relationship", "description": "A reference to a iamIdpReference resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iam.UserSetting.List": { "title": "List of 'iam.UserSetting' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iam.UserSetting' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iam.UserSetting' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iam.UserSetting" }, "nullable": true } } } ] }, "imcconnector.WebUiMessage": { "title": "Imcconnector:Web Ui Message", "description": "Message contains the request to send to the platforms management entities HTTP server. Returns the HTTP response body from the platform, or error if plugin encounters error executing the request.", "x-allOf-name": "imcconnector.WebUiMessage", "allOf": [ { "$ref": "#/components/schemas/connector.AuthMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'imcconnector.WebUiMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "imcconnector.WebUiMessage" ], "default": "imcconnector.WebUiMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "imcconnector.WebUiMessage" ], "default": "imcconnector.WebUiMessage", "x-enum-as-string": true }, "WebUiRequest": { "description": "The body content of the UI HTTP request to send to the BMC platform.", "type": "string", "x-omitempty": true } } } ] }, "infra.BaseCluster.Relationship": { "description": "A relationship to the 'infra.BaseCluster' resource, or the expanded 'infra.BaseCluster' resource, or the 'null' value.", "x-one-of-name": "infra.BaseCluster.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/infra.BaseCluster" } ], "discriminator": { "propertyName": "ClassId" } }, "infra.BaseCluster": { "title": "Infra:Base Cluster", "description": "Common attributes of a cluster of resources within a datacenter. A cluster is a convenient grouping of resources such as Host, Datastore, etc.", "x-allOf-name": "infra.BaseCluster", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'infra.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", "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": [ "hyperflex.Cluster", "virtualization.VmwareCluster" ], "x-enum-as-string": true }, "Name": { "description": "The user-provided name for this cluster to facilitate identification.", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_-]{1,32}$", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Cluster health status as reported by the hypervisor platform.\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 } } } ] }, "infra.BaseGpuConfiguration": { "title": "Infra:Base Gpu Configuration", "description": "Common GPU configuration on a compute resource (BM or VM).", "x-allOf-name": "infra.BaseGpuConfiguration", "allOf": [ { "$ref": "#/components/schemas/infra.BasePciConfiguration" }, { "type": "object", "description": "Definition of the list of properties defined in 'infra.BaseGpuConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "infra.GpuConfiguration", "infra.MigGpuConfiguration" ], "x-enum-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": [ "infra.GpuConfiguration", "infra.MigGpuConfiguration" ], "x-enum-as-string": true }, "MemorySize": { "description": "The amount of memory on the GPU (GBs).", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "infra.BasePciConfiguration": { "title": "Infra:Base Pci Configuration", "description": "Common PCI device configuration on a compute resource (BareMetal - BM, or VirtualMachine - VM).", "x-allOf-name": "infra.BasePciConfiguration", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'infra.BasePciConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "infra.GpuConfiguration", "infra.MigGpuConfiguration" ], "x-enum-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": [ "infra.GpuConfiguration", "infra.MigGpuConfiguration" ], "x-enum-as-string": true }, "DeviceId": { "description": "The device Id of the GPU device.", "type": "integer", "format": "int64", "x-omitempty": true }, "VendorId": { "description": "The vendor Id of the GPU device.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "infra.GpuConfiguration": { "title": "Infra:Gpu Configuration", "description": "Generic GPU configuration on a compute resource (BM or VM).", "x-allOf-name": "infra.GpuConfiguration", "allOf": [ { "$ref": "#/components/schemas/infra.BaseGpuConfiguration" } ] }, "infra.HardwareInfo": { "title": "Infra:Hardware Info", "description": "Information about the hardware platform (cpu, memory).", "x-allOf-name": "infra.HardwareInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'infra.HardwareInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "infra.HardwareInfo" ], "default": "infra.HardwareInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "infra.HardwareInfo" ], "default": "infra.HardwareInfo", "x-enum-as-string": true }, "CpuCores": { "description": "The number of cpu cores on this hardware platform.", "type": "integer", "format": "int64", "x-omitempty": true }, "CpuSpeed": { "description": "Speed of cpu in MHz. Usually cpu speeds are reported for modern cpus in GHz but MHz makes it more precise.", "type": "integer", "format": "int64", "x-omitempty": true }, "MemorySize": { "description": "The amount of memory allocated (bytes) to this hardware platform.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "infra.MetaData": { "title": "Infra:Meta Data", "description": "User defined entity label for identifying resource.", "x-allOf-name": "infra.MetaData", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'infra.MetaData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "infra.MetaData" ], "default": "infra.MetaData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "infra.MetaData" ], "default": "infra.MetaData", "x-enum-as-string": true }, "Name": { "description": "Name of the meta property which identifies a specific resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Value": { "description": "Value of the meta property which identifies a specific resource.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "infra.MigGpuConfiguration": { "title": "Infra:Mig Gpu Configuration", "description": "Nvidia MIG capable GPU configuration on a compute resource (BM or VM).", "x-allOf-name": "infra.MigGpuConfiguration", "allOf": [ { "$ref": "#/components/schemas/infra.BaseGpuConfiguration" }, { "type": "object", "description": "Definition of the list of properties defined in 'infra.MigGpuConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "infra.MigGpuConfiguration" ], "default": "infra.MigGpuConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "infra.MigGpuConfiguration" ], "default": "infra.MigGpuConfiguration", "x-enum-as-string": true }, "MigProfileName": { "description": "The predefined MIG profile name, e.g. 1g.5gb, 2g.10gb, etc.", "type": "string", "x-omitempty": true } } } ] }, "issue.Condition": { "title": "Issue:Condition", "description": "Condition defines the set of criteria under which an issue exists.", "x-allOf-name": "issue.Condition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "issue.Definition": { "title": "Issue:Definition", "description": "The definition of an issue which encompases the criteria for identifying when the issue exists, documentation of the detected issue, and actions to be taken by Intersight, e.g. raising of an alarm or triggering of a workflow to perform remediation.", "x-allOf-name": "issue.Definition", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'issue.Definition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "cond.AlarmDefinition", "cond.ThresholdDefinition" ], "x-enum-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": [ "cond.AlarmDefinition", "cond.ThresholdDefinition" ], "x-enum-as-string": true }, "Condition": { "description": "Condition defines the set of criteria under which an issue exists.", "$ref": "#/components/schemas/issue.Condition", "x-omitempty": true }, "Description": { "description": "A description of the issue which is common to all instances of the issue.", "type": "string", "x-omitempty": true }, "Name": { "description": "An informational display name.", "type": "string", "minLength": 2, "maxLength": 50, "x-omitempty": true }, "ProbableCause": { "description": "An explanation of the likely causes of the detected issue.", "type": "string", "x-omitempty": true }, "Remediation": { "description": "An explanation of the steps to perform to remediate the detected issue.", "type": "string", "x-omitempty": true }, "SystemClassifications": { "type": "array", "items": { "description": "The system defined classifications name to which this alarm is added. This alarm will be suppressed when there is a suppression enabled at an entity for any of the classifications listed here.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "issue.DeviceTag": { "title": "Issue:Device Tag", "description": "An arbitrary key and value pair that can be used to tag REST resources and organize managed objects by\nassigning meta-data tags to any object.", "x-allOf-name": "issue.DeviceTag", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'issue.DeviceTag', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "issue.DeviceTag" ], "default": "issue.DeviceTag", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "issue.DeviceTag" ], "default": "issue.DeviceTag", "x-enum-as-string": true }, "Key": { "description": "The string representation of a tag key.", "type": "string", "x-omitempty": true }, "Value": { "description": "The string representation of a tag value.", "type": "string", "x-omitempty": true } } } ] }, "issue.Message": { "title": "Issue:Message", "description": "A message which is optionally parameterized and which supports language localization.", "x-allOf-name": "issue.Message", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'issue.Message', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "issue.Message" ], "default": "issue.Message", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "issue.Message" ], "default": "issue.Message", "x-enum-as-string": true }, "Message": { "description": "A parameterized message such as \"The temperature is %[1]v.\" where 'hot' could be substituted for %[1]v.", "type": "string", "x-omitempty": true }, "Parameters": { "type": "array", "items": { "description": "A list of parameters used to construct the 'message'.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "issue.OdataCondition": { "title": "Issue:Odata Condition", "description": "OdataCondition defines, via an Odata predicate, a set of criteria under which an issue exists.", "x-allOf-name": "issue.OdataCondition", "allOf": [ { "$ref": "#/components/schemas/issue.Condition" }, { "type": "object", "description": "Definition of the list of properties defined in 'issue.OdataCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "issue.OdataCondition" ], "default": "issue.OdataCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "issue.OdataCondition" ], "default": "issue.OdataCondition", "x-enum-as-string": true }, "DeviceTags": { "type": "array", "items": { "description": "Devicetags are used to control whether an alarm definition is evaluated against a specific instance of the named 'motype' by requiring that the MO instance be owned by a DevivceRegistration (ie the MO is DC reported inventory) and that one or more of the Key/Value pairs specified in devicetags match the corresponding asset.DeviceRegistration.Tags. The relevant DeviceRegistration instance is determined based on the relationship named 'RegisteredDevice' on the MO instance. Devicetags is optional and when not specified, the alarm definition is evaluated against all instances of the motype. If devicetags is specified and the 'RegisteredDevice' relationship does not exist, this is a runtime error and the alarm definition is not evaluated for the MO instance.", "$ref": "#/components/schemas/issue.DeviceTag", "x-omitempty": true }, "nullable": true }, "Motype": { "description": "The Intersight object type on which the condition is to be applied. The object type may be either a concrete type such as compute.RackUnit or a shared parent type such as compute.Physical.", "type": "string", "x-omitempty": true }, "Query": { "description": "An Odata query string interpreted to be the value portion of a $filter expression. For example, for the function query $filter=Serial eq 'ABC', the 'query' field should be assigned the string Serial eq 'ABC.", "type": "string", "x-omitempty": true } } } ] }, "iwotenant.MaintenanceNotification.Response": { "description": "The response body of a HTTP GET request for the 'iwotenant.MaintenanceNotification' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iwotenant.MaintenanceNotification' resources.", "x-one-of-name": "iwotenant.MaintenanceNotification.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iwotenant.MaintenanceNotification.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iwotenant.MaintenanceNotification": { "title": "Iwotenant:Maintenance Notification", "description": "MaintenanceNotifications represent maintenance-related messages intended to be shown to users as a UI banner when they log in. The notification is scoped to an IWO tenant (by `iwoId`) and can be tied to an account/tenant relationship for targeted communication.\n#### Purpose\nCommunicate planned IWO maintenance windows to customers through a time-bounded banner message, improving transparency and reducing surprise during service-impacting operations.\n#### Key Concepts\n- **UI banner communication:** Stores message content (or an i18n key) for consistent UI display.\n- **Time window control:** Defines when to show the message (`showFromTime` \u2192 `showUntilTime`) and when maintenance actually starts (`maintenanceStartTime`).\n- **Tenant identification:** Uses `iwoId` to bind the notification to the intended tenant namespace/account context.\n- **Lifecycle management:** Admin-controlled create/delete, enabling planned messaging only when needed.", "x-allOf-name": "iwotenant.MaintenanceNotification", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iwotenant.MaintenanceNotification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iwotenant.MaintenanceNotification" ], "default": "iwotenant.MaintenanceNotification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iwotenant.MaintenanceNotification" ], "default": "iwotenant.MaintenanceNotification", "x-enum-as-string": true }, "I18nKey": { "description": "Any i18n (internationalization) key defined the message content. If the key already exists then the message content will be picked based on the key, otherwise provided message value will be used.", "type": "string", "x-omitempty": true }, "IwoId": { "description": "The iwoId uniquely identifies a IWO tenant. The iwoId is used as part of namespace, (logical) database names, policies in vault and many others. As of now, accountMoid has to be provided as the iwoId.", "type": "string", "x-omitempty": true }, "MaintenanceStartTime": { "description": "The date/time from which the actual maintenance operations will be performed for a Customer's account.", "type": "string", "format": "date-time", "x-omitempty": true }, "NtfnMessage": { "description": "The notification message content is to display in the UI banner after the Customer's login to inform about planned maintenance operations on IWO.", "type": "string", "minLength": 32, "maxLength": 256, "x-omitempty": true }, "ShowFromTime": { "description": "The date/time from which the maintenance banner message will be shown to the Customer after login in to Intersight UI.", "type": "string", "format": "date-time", "x-omitempty": true }, "ShowUntilTime": { "description": "The date/time until which the maintenance banner message will be shown to the Customer after login into Intersight UI. This will also be the time actual maintenance operation is planned for the finish of a Customer's account.", "type": "string", "format": "date-time", "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "iwotenant.MaintenanceNotification.List": { "title": "List of 'iwotenant.MaintenanceNotification' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iwotenant.MaintenanceNotification' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iwotenant.MaintenanceNotification' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iwotenant.MaintenanceNotification" }, "nullable": true } } } ] }, "iwotenant.Migrate.Response": { "description": "The response body of a HTTP GET request for the 'iwotenant.Migrate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iwotenant.Migrate' resources.", "x-one-of-name": "iwotenant.Migrate.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iwotenant.Migrate.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iwotenant.Migrate": { "title": "Iwotenant:Migrate", "description": "Migrates provide an API surface to transfer a customer's IWO data, including the information required to stage migration artifacts (for example, an S3 URL) and protect access with a password that meets complexity requirements.\n#### Purpose\nEnable controlled migration of IWO tenant data for an account, coordinating the migration operation with the account and its associated tenant.\n#### Key Concepts\n- **Migration staging location:** Uses a URL (for example, an object storage bucket endpoint) to upload or access migration data.\n- **Protected operation:** Requires a password (stored securely/encrypted) to safeguard migration artifacts or processes.\n- **Account and tenant linkage:** Ties the migration request to the relevant account and (optionally) the tenant for context and governance.\n- **Lifecycle controls:** Supports create/update for initiating/configuring migration and delete for administrative cleanup.", "x-allOf-name": "iwotenant.Migrate", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iwotenant.Migrate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iwotenant.Migrate" ], "default": "iwotenant.Migrate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iwotenant.Migrate" ], "default": "iwotenant.Migrate", "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 that satisfies Cisco's Password Complexity security requirement.\nMinimum password length, which MUST be nonzero and up to the current maximum length\nContain both upper-case and lower-case letters\nContain at least one number (for example, 0-9)\nContain at least one special character.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Url": { "description": "S3 bucket URL for uploading the migration data.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "iwotenant.Migrate.List": { "title": "List of 'iwotenant.Migrate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iwotenant.Migrate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iwotenant.Migrate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iwotenant.Migrate" }, "nullable": true } } } ] }, "iwotenant.TenantCustomization.Response": { "description": "The response body of a HTTP GET request for the 'iwotenant.TenantCustomization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iwotenant.TenantCustomization' resources.", "x-one-of-name": "iwotenant.TenantCustomization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iwotenant.TenantCustomization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iwotenant.TenantCustomization": { "title": "Iwotenant:Tenant Customization", "description": "The TenantCustomization object allows end-users to tailor their IWO tenant configurations, enhancing functionality through options like enabling data extractors.\n#### Purpose\nThe TenantCustomization object provides mechanisms for users to customize their tenant environments, offering flexibility in data handling and feature management. \n#### Key Concepts\n- **Data Management:** Enables the activation of data extractors, facilitating reporting and analysis within the tenant's namespace.\n- **Customization Flexibility:** Provides options for users to enhance tenant capabilities according to their specific requirements.\n- **Account Linkage:** Maintains associations with relevant accounts and tenants, ensuring consistent customization across linked entities.", "x-allOf-name": "iwotenant.TenantCustomization", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iwotenant.TenantCustomization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iwotenant.TenantCustomization" ], "default": "iwotenant.TenantCustomization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iwotenant.TenantCustomization" ], "default": "iwotenant.TenantCustomization", "x-enum-as-string": true }, "EnableDataExtractor": { "description": "Enables IWO tenant data to be available for reporting. This will start 'extractor' pod.", "type": "boolean", "x-omitempty": true }, "IsWriteUserAccessKeyIdSet": { "description": "Indicates whether the value of the 'writeUserAccessKeyId' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsWriteUserSecretAccessKeySet": { "description": "Indicates whether the value of the 'writeUserSecretAccessKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IwoId": { "description": "The iwoId uniquely identifies a IWO tenant. The iwoId is used as part of namespace, (logical) database names, policies in vault and many others. As of now, accountMoid has to be provided as the iwoId.", "type": "string", "x-omitempty": true }, "MskServerForDataExtractor": { "description": "MSK cluster endpoint that data extractor can send reporting data to. This MS cluster in turn populates data into tables in Redshift cluster.", "type": "string", "x-omitempty": true }, "WriteUserAccessKeyId": { "description": "AWS access key Id to write data to redshift. Refer to AWS cloud formation stack 'Output' of the tenant.", "type": "string", "writeOnly": true, "x-omitempty": true }, "WriteUserSecretAccessKey": { "description": "AWS secret access key to write data to redshift. Refer to AWS cloud formation stack 'Output' of the tenant.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "iwotenant.TenantCustomization.List": { "title": "List of 'iwotenant.TenantCustomization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iwotenant.TenantCustomization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iwotenant.TenantCustomization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iwotenant.TenantCustomization" }, "nullable": true } } } ] }, "iwotenant.TenantStatus.Response": { "description": "The response body of a HTTP GET request for the 'iwotenant.TenantStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iwotenant.TenantStatus' resources.", "x-one-of-name": "iwotenant.TenantStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iwotenant.TenantStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iwotenant.TenantStatus": { "title": "Iwotenant:Tenant Status", "description": "TenantStatuses provide a customer-visible status and health indicator for IWO tenant provisioning. Because IWO features depend on the tenant namespace becoming healthy, this object exposes whether tenant creation is still in progress, completed, or has failed, with a reference timestamp used to detect timeouts during upgrades/reconfiguration.\n#### Purpose\nExpose the operational readiness of an IWO tenant to users and dependent features, enabling UI/automation to inform customers when the tenant is not yet usable or requires attention.\n#### Key Concepts\n- **Provisioning lifecycle state:** Reports deployment progress using a simplified status model (NotStarted/InProgress/Completed/Failed).\n- **Timeout/reference tracking:** Uses `referenceTime` during upgrade/reconfiguration to detect when an operation exceeds expected time bounds.\n- **Tenant identity anchor:** Uses `iwoId` as the key identifier aligned to the tenant namespace/account context.\n- **Correlated relationships:** Links to both the account and the underlying Tenant object for navigation and lifecycle coupling.", "x-allOf-name": "iwotenant.TenantStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iwotenant.TenantStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iwotenant.TenantStatus" ], "default": "iwotenant.TenantStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iwotenant.TenantStatus" ], "default": "iwotenant.TenantStatus", "x-enum-as-string": true }, "DeployStatus": { "description": "The deployStatus provides the current status of this deployment.\n* `NotStarted` - The workflow to deploy the tenant cluster has not yet started.\n* `InProgress` - The workflow to deploy the tenant cluster in progress. All the tasks required for thesuccessful tenant creation are running.\n* `Completed` - The workflow to deploy the tenant cluster has completed and health checks have passed.\n* `Failed` - The workflow to deploy the tenant cluster has failed. Detailed reason for the failure isprovided from Tenant.deployStatus.", "type": "string", "enum": [ "NotStarted", "InProgress", "Completed", "Failed" ], "default": "NotStarted", "readOnly": true, "x-omitempty": true }, "IwoId": { "description": "The iwoId uniquely identifies a IWO tenant. The iwoId is used as part of namespace, (logical) database names, policies in vault and many others. As of now, accountMoid has to be provided as the iwoId.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReferenceTime": { "description": "During IWO tenant upgrade (or reconfiguration), deployStatus is set to InProgress and referenceTime set to current time. When tenant upgrade (or reconfiguration) does not complete within a pre-defined time using this as reference, deployStatus is set as Failed.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "iwotenant.TenantStatus.List": { "title": "List of 'iwotenant.TenantStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iwotenant.TenantStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iwotenant.TenantStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iwotenant.TenantStatus" }, "nullable": true } } } ] }, "license.AccountLicenseData.Response": { "description": "The response body of a HTTP GET request for the 'license.AccountLicenseData' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.AccountLicenseData' resources.", "x-one-of-name": "license.AccountLicenseData.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.AccountLicenseData.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.AccountLicenseData.Relationship": { "description": "A relationship to the 'license.AccountLicenseData' resource, or the expanded 'license.AccountLicenseData' resource, or the 'null' value.", "x-one-of-name": "license.AccountLicenseData.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.AccountLicenseData" } ], "discriminator": { "propertyName": "ClassId" } }, "license.AccountLicenseData": { "title": "License:Account License Data", "description": "License information for an account.", "x-allOf-name": "license.AccountLicenseData", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.AccountLicenseData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.AccountLicenseData" ], "default": "license.AccountLicenseData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.AccountLicenseData" ], "default": "license.AccountLicenseData", "x-enum-as-string": true }, "AccountId": { "description": "Root user's ID of the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "AgentData": { "description": "Agent trusted store data.", "type": "string", "readOnly": true, "x-omitempty": true }, "AuthExpireTime": { "description": "Authorization expiration time.", "type": "string", "readOnly": true, "x-omitempty": true }, "AuthInitialTime": { "description": "Intial authorization time.", "type": "string", "readOnly": true, "x-omitempty": true }, "AuthNextTime": { "description": "Next time for the authorization.", "type": "string", "readOnly": true, "x-omitempty": true }, "Category": { "description": "Account license data category name.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultLicenseType": { "description": "Default license tier set by the user.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "x-omitempty": true }, "DefaultLicenseTypeNewerModels": { "description": "Default license tier for newer model M7+ servers set by the user.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "x-omitempty": true }, "ErrorDesc": { "description": "The detailed error message when there is any error related to license sync of this account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Group": { "description": "Account license data group name.", "type": "string", "readOnly": true, "x-omitempty": true }, "HighestCompliantLicenseTier": { "description": "The highest license tier which is in compliant of this account.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "readOnly": true, "x-omitempty": true }, "LastCssmSync": { "description": "Specifies last sync time with CSSM.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastRenew": { "description": "Specifies last certificate renew time with SA.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastSync": { "description": "Specifies last sync time with SA.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastUpdatedTime": { "description": "Record's last update datetime.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LicenseState": { "description": "Aggregrated mode for the agent.", "type": "string", "readOnly": true, "x-omitempty": true }, "LicenseTechSupportInfo": { "description": "Tech-support info of a smart-agent.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisterExpireTime": { "description": "Registration exipiration time.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisterInitialTime": { "description": "Initial time of registration.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisterNextTime": { "description": "Next time for the license registration.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegistrationStatus": { "description": "Registration status of a smart-agent.", "type": "string", "readOnly": true, "x-omitempty": true }, "RenewFailureString": { "description": "License renewal failure message.", "type": "string", "readOnly": true, "x-omitempty": true }, "SmartAccount": { "description": "Name of the smart account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SmartAccountDomain": { "description": "Domain Name of the smart account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SmartApiEnabled": { "description": "Indicate whether API integration is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SmartApiSyncStatus": { "description": "The detailed error message when there is any smart API sync error related to this account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SyncStatus": { "description": "Current sync status for the account.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualAccount": { "description": "Name of the virtual account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "CustomerOp": { "$ref": "#/components/schemas/license.CustomerOp.Relationship", "description": "A reference to a licenseCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ErpCustomerOp": { "$ref": "#/components/schemas/license.ErpCustomerOp.Relationship", "description": "A reference to a licenseErpCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ErpLicenseCount": { "$ref": "#/components/schemas/license.ErpLicenseCount.Relationship", "description": "A reference to a licenseErpLicenseCount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IksCustomerOp": { "$ref": "#/components/schemas/license.IksCustomerOp.Relationship", "description": "A reference to a licenseIksCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IksLicenseCount": { "$ref": "#/components/schemas/license.IksLicenseCount.Relationship", "description": "A reference to a licenseIksLicenseCount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IncCustomerOp": { "$ref": "#/components/schemas/license.IncCustomerOp.Relationship", "description": "A reference to a licenseIncCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IncLicenseCount": { "$ref": "#/components/schemas/license.IncLicenseCount.Relationship", "description": "A reference to a licenseIncLicenseCount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IwoCustomerOp": { "$ref": "#/components/schemas/license.IwoCustomerOp.Relationship", "description": "A reference to a licenseIwoCustomerOp resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IwoLicenseCount": { "$ref": "#/components/schemas/license.IwoLicenseCount.Relationship", "description": "A reference to a licenseIwoLicenseCount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LicenseInfoView": { "$ref": "#/components/schemas/license.LicenseInfoView.Relationship", "description": "A reference to a licenseLicenseInfoView resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LicenseRegistrationStatus": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus.Relationship", "description": "A reference to a licenseLicenseRegistrationStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Licenseinfos": { "description": "An array of relationships to licenseLicenseInfo resources.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseInfo.Relationship" }, "nullable": true }, "SmartlicenseToken": { "$ref": "#/components/schemas/license.SmartlicenseToken.Relationship", "description": "A reference to a licenseSmartlicenseToken resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.AccountLicenseData.List": { "title": "List of 'license.AccountLicenseData' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.AccountLicenseData' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.AccountLicenseData' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.AccountLicenseData" }, "nullable": true } } } ] }, "license.CustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.CustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.CustomerOp' resources.", "x-one-of-name": "license.CustomerOp.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.CustomerOp.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.CustomerOp.Relationship": { "description": "A relationship to the 'license.CustomerOp' resource, or the expanded 'license.CustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.CustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.CustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.CustomerOp": { "title": "License:Customer Op", "description": "CustomerOp object is integral to managing customer operations related to license registration and authentication within the system. This provides mechanisms for refreshing registration, renewing authorization, and enabling licensing features, ensuring seamless interaction with licensing services.\n#### Purpose\nCustomerOp object facilitates the management of licensing-related operations for customers. It allows users to trigger renewals, initiate trials, and manage registration states, providing a central interface for these critical operations.\n#### Key Concepts\n- **License Management:** Offers functionality to renew registration and authorization, ensuring licenses remain valid and operational.\n- **Trial Enablement:** Supports enabling trial modes for licensing, allowing customers to evaluate services before committing.\n- **Administrative Control:** Provides properties for activating license entitlements, ensuring customers can manage their license states effectively.\n- **Shared Organizational Resource:** Designed to operate within shared organizational contexts, allowing consistent application across different accounts and user roles.", "x-allOf-name": "license.CustomerOp", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.CustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.CustomerOp" ], "default": "license.CustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.CustomerOp" ], "default": "license.CustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The license administrative state.\nSet this property to 'true' to activate the license entitlements.", "type": "boolean", "x-omitempty": true }, "AllDevicesToDefaultTier": { "description": "Move all licensed devices to default license tier.", "type": "boolean", "x-omitempty": true }, "ClearApiSyncStatus": { "description": "Clear the status of smart API sync.", "type": "boolean", "x-omitempty": true }, "DeregisterDevice": { "description": "Trigger de-registration/disable.", "type": "boolean", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for Intersight licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "RenewAuthorization": { "description": "Trigger renew authorization.", "type": "boolean", "x-omitempty": true }, "RenewIdCertificate": { "description": "Trigger renew registration.", "type": "boolean", "x-omitempty": true }, "ShowAgentTechSupport": { "description": "Trigger show tech support feature.", "type": "boolean", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.CustomerOp.List": { "title": "List of 'license.CustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.CustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.CustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.CustomerOp" }, "nullable": true } } } ] }, "license.ErpCustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.ErpCustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.ErpCustomerOp' resources.", "x-one-of-name": "license.ErpCustomerOp.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.ErpCustomerOp.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.ErpCustomerOp.Relationship": { "description": "A relationship to the 'license.ErpCustomerOp' resource, or the expanded 'license.ErpCustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.ErpCustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.ErpCustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.ErpCustomerOp": { "title": "License:Erp Customer Op", "description": "The ErpCustomerOp object is crucial for managing operations related to ERP licensing, providing tools for trial enablement and administrative controls.\n#### Purpose\nErpCustomerOp serves as the operational interface for ERP license management, offering functionalities for trial periods and tier settings, ensuring customers can effectively manage their ERP configurations.\n#### Key Concepts\n- **ERP Licensing:** Focuses on the management of ERP service licenses, ensuring customers can tailor their configurations to business needs.\n- **Trial Enablement:** Allows activation of trial modes, offering opportunities to explore ERP service features.\n- **License Tier Management:** Supports settings for active tiers, providing flexibility in service configuration and utilization.\n- **Administrative Activation:** Provides controls for activating licenses, ensuring customers maintain access to ERP service capabilities.", "x-allOf-name": "license.ErpCustomerOp", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.ErpCustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.ErpCustomerOp" ], "default": "license.ErpCustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.ErpCustomerOp" ], "default": "license.ErpCustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The ERP license administrative state.\nSet this property to 'true' to activate the ERP license entitlements.", "type": "boolean", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for ERP licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period the customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.ErpCustomerOp.List": { "title": "List of 'license.ErpCustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.ErpCustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.ErpCustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.ErpCustomerOp" }, "nullable": true } } } ] }, "license.ErpLicenseCount.Response": { "description": "The response body of a HTTP GET request for the 'license.ErpLicenseCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.ErpLicenseCount' resources.", "x-one-of-name": "license.ErpLicenseCount.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.ErpLicenseCount.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.ErpLicenseCount.Relationship": { "description": "A relationship to the 'license.ErpLicenseCount' resource, or the expanded 'license.ErpLicenseCount' resource, or the 'null' value.", "x-one-of-name": "license.ErpLicenseCount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.ErpLicenseCount" } ], "discriminator": { "propertyName": "ClassId" } }, "license.ErpLicenseCount": { "title": "License:Erp License Count", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.ErpLicenseCount", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.ErpLicenseCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.ErpLicenseCount" ], "default": "license.ErpLicenseCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.ErpLicenseCount" ], "default": "license.ErpLicenseCount", "x-enum-as-string": true }, "AdvantageCount": { "description": "The total number of devices claimed in the Erp workflow Advantage tier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.ErpLicenseCount.List": { "title": "List of 'license.ErpLicenseCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.ErpLicenseCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.ErpLicenseCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.ErpLicenseCount" }, "nullable": true } } } ] }, "license.IksCustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.IksCustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IksCustomerOp' resources.", "x-one-of-name": "license.IksCustomerOp.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IksCustomerOp.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IksCustomerOp.Relationship": { "description": "A relationship to the 'license.IksCustomerOp' resource, or the expanded 'license.IksCustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.IksCustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IksCustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IksCustomerOp": { "title": "License:Iks Customer Op", "description": "The IksCustomerOp object handles customer operations related to the Intersight Kubernetes Service (IKS) licensing, providing mechanisms for trial enablement and tier management.\n#### Purpose\nIksCustomerOp is designed to facilitate the management of Kubernetes service licenses. It enables trial periods, tier settings, and administrative controls, ensuring customers can leverage Kubernetes services effectively.\n#### Key Concepts\n- **Kubernetes Service Management:** Focuses on the licensing aspects of Kubernetes services, ensuring customers can optimize their configurations.\n- **Trial Enablement:** Allows users to activate trial modes, providing opportunities to explore Kubernetes service features.\n- **License Tier Configuration:** Supports active tier settings, allowing customization based on customer requirements and service levels.\n- **Administrative Entitlements:** Provides controls to activate licenses, ensuring customers maintain access to Kubernetes service capabilities.", "x-allOf-name": "license.IksCustomerOp", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IksCustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IksCustomerOp" ], "default": "license.IksCustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IksCustomerOp" ], "default": "license.IksCustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The Intersight Kubernetes Service license administrative state.\nSet this property to 'true' to activate the IKS license entitlements.", "type": "boolean", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for IKS licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period the customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IksCustomerOp.List": { "title": "List of 'license.IksCustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IksCustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IksCustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IksCustomerOp" }, "nullable": true } } } ] }, "license.IksLicenseCount.Response": { "description": "The response body of a HTTP GET request for the 'license.IksLicenseCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IksLicenseCount' resources.", "x-one-of-name": "license.IksLicenseCount.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IksLicenseCount.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IksLicenseCount.Relationship": { "description": "A relationship to the 'license.IksLicenseCount' resource, or the expanded 'license.IksLicenseCount' resource, or the 'null' value.", "x-one-of-name": "license.IksLicenseCount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IksLicenseCount" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IksLicenseCount": { "title": "License:Iks License Count", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.IksLicenseCount", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IksLicenseCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IksLicenseCount" ], "default": "license.IksLicenseCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IksLicenseCount" ], "default": "license.IksLicenseCount", "x-enum-as-string": true }, "AdvantageCount": { "description": "The total number of devices claimed in the IKS Advantage tier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IksLicenseCount.List": { "title": "List of 'license.IksLicenseCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IksLicenseCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IksLicenseCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IksLicenseCount" }, "nullable": true } } } ] }, "license.IncCustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.IncCustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IncCustomerOp' resources.", "x-one-of-name": "license.IncCustomerOp.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IncCustomerOp.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IncCustomerOp.Relationship": { "description": "A relationship to the 'license.IncCustomerOp' resource, or the expanded 'license.IncCustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.IncCustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IncCustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IncCustomerOp": { "title": "License:Inc Customer Op", "description": "The IncCustomerOp object is central to managing operations related to the Intersight Nexus Cloud (INC) licensing, offering functionalities for trial management and administrative control.\n#### Purpose \nIncCustomerOp facilitates management of Nexus Cloud licenses, providing tools for trial enablement and tier configuration. It ensures customers can access and manage cloud services efficiently.\n#### Key Concepts \n- **Nexus Cloud Licensing:** Centralizes management of cloud service licenses, allowing customers to optimize their cloud configurations.\n- **Trial Management:** Supports enabling and terminating trial periods, providing flexibility in evaluating cloud services.\n- **Tier Configuration:** Offers settings for active license tiers, ensuring customers can tailor cloud services to their operational needs.\n- **Administrative Activation:** Empowers users to activate license entitlements, ensuring access to cloud service capabilities.", "x-allOf-name": "license.IncCustomerOp", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IncCustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IncCustomerOp" ], "default": "license.IncCustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IncCustomerOp" ], "default": "license.IncCustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The Nexus Cloud license administrative state.\nSet this property to 'true' to activate the Nexus Cloud license entitlements.", "type": "boolean", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for Nexus Cloud licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period the customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "TerminateTrial": { "description": "Terminate trial mode for Nexus Cloud.", "type": "boolean", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IncCustomerOp.List": { "title": "List of 'license.IncCustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IncCustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IncCustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IncCustomerOp" }, "nullable": true } } } ] }, "license.IncLicenseCount.Response": { "description": "The response body of a HTTP GET request for the 'license.IncLicenseCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IncLicenseCount' resources.", "x-one-of-name": "license.IncLicenseCount.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IncLicenseCount.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IncLicenseCount.Relationship": { "description": "A relationship to the 'license.IncLicenseCount' resource, or the expanded 'license.IncLicenseCount' resource, or the 'null' value.", "x-one-of-name": "license.IncLicenseCount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IncLicenseCount" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IncLicenseCount": { "title": "License:Inc License Count", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.IncLicenseCount", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IncLicenseCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IncLicenseCount" ], "default": "license.IncLicenseCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IncLicenseCount" ], "default": "license.IncLicenseCount", "x-enum-as-string": true }, "Premier100GfxCount": { "description": "The total number of devices claimed in the premier 100G fixed tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Premier10GfxCount": { "description": "The total number of devices claimed in the premier 10G fixed tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Premier1GfxCount": { "description": "The total number of devices claimed in the premier 1G fixed tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierCentralizedMod8SlotCount": { "description": "The total number of devices claimed in the CentralizedMod8Slot premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierD2OpsFixedCount": { "description": "The total number of devices claimed in the D2Ops Fixed premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierD2OpsModCount": { "description": "The total number of devices claimed in the D2Ops modular premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierDistributedMod8SlotCount": { "description": "The total number of devices claimed in the DistributedMod8Slot premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierMod4SlotCount": { "description": "The total number of devices claimed in the modular 4 slot premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PremierMod8SlotCount": { "description": "The total number of devices claimed in the modular 8 slot premier tier Intersight Nexus Cloud.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IncLicenseCount.List": { "title": "List of 'license.IncLicenseCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IncLicenseCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IncLicenseCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IncLicenseCount" }, "nullable": true } } } ] }, "license.IwoCustomerOp.Response": { "description": "The response body of a HTTP GET request for the 'license.IwoCustomerOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IwoCustomerOp' resources.", "x-one-of-name": "license.IwoCustomerOp.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IwoCustomerOp.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IwoCustomerOp.Relationship": { "description": "A relationship to the 'license.IwoCustomerOp' resource, or the expanded 'license.IwoCustomerOp' resource, or the 'null' value.", "x-one-of-name": "license.IwoCustomerOp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IwoCustomerOp" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IwoCustomerOp": { "title": "License:Iwo Customer Op", "description": "The IwoCustomerOp object focuses on operations related to the Intersight Workload Optimizer (IWO) licensing, offering tools for managing license tiers and trials within the workload optimization context.\n#### Purpose\nIwoCustomerOp serves as the operational interface for managing workload optimizer licensing. It supports administrative functions, trial enablement, and tier management, ensuring customers can optimize their licensing configurations.\n#### Key Concepts\n- **Workload Optimization:** Facilitates management of IWO license entitlements, allowing customers to tailor their optimization settings to specific needs.\n- **License Tier Management:** Supports setting and managing active license types, providing flexibility in how services are configured and utilized.\n- **Trial Operations:**Enables trial periods for customers to assess the workload optimizer features and benefits.\n- **Administrative Activation:** Allows activation of license entitlements, ensuring operational continuity and access to optimizer capabilities.", "x-allOf-name": "license.IwoCustomerOp", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IwoCustomerOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IwoCustomerOp" ], "default": "license.IwoCustomerOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IwoCustomerOp" ], "default": "license.IwoCustomerOp", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The workload optimizer license administrative state.\nSet this property to 'true' to activate the workload optimizer license entitlements.", "type": "boolean", "x-omitempty": true }, "ActiveLicenseType": { "description": "Active workload optimizer license tier set by user.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "x-omitempty": true }, "EnableTrial": { "description": "Enable trial for Intersight licensing.", "type": "boolean", "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended. The trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IwoCustomerOp.List": { "title": "List of 'license.IwoCustomerOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IwoCustomerOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IwoCustomerOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IwoCustomerOp" }, "nullable": true } } } ] }, "license.IwoLicenseCount.Response": { "description": "The response body of a HTTP GET request for the 'license.IwoLicenseCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.IwoLicenseCount' resources.", "x-one-of-name": "license.IwoLicenseCount.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.IwoLicenseCount.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.IwoLicenseCount.Relationship": { "description": "A relationship to the 'license.IwoLicenseCount' resource, or the expanded 'license.IwoLicenseCount' resource, or the 'null' value.", "x-one-of-name": "license.IwoLicenseCount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.IwoLicenseCount" } ], "discriminator": { "propertyName": "ClassId" } }, "license.IwoLicenseCount": { "title": "License:Iwo License Count", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.IwoLicenseCount", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.IwoLicenseCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.IwoLicenseCount" ], "default": "license.IwoLicenseCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.IwoLicenseCount" ], "default": "license.IwoLicenseCount", "x-enum-as-string": true }, "VmLicenseCount": { "description": "The total number of devices claimed in the Intersight account.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.IwoLicenseCount.List": { "title": "List of 'license.IwoLicenseCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.IwoLicenseCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.IwoLicenseCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.IwoLicenseCount" }, "nullable": true } } } ] }, "license.LicenseInfo.Response": { "description": "The response body of a HTTP GET request for the 'license.LicenseInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.LicenseInfo' resources.", "x-one-of-name": "license.LicenseInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.LicenseInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.LicenseInfo.Relationship": { "description": "A relationship to the 'license.LicenseInfo' resource, or the expanded 'license.LicenseInfo' resource, or the 'null' value.", "x-one-of-name": "license.LicenseInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.LicenseInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "license.LicenseInfo": { "title": "License:License Info", "description": "License state information for a specific license entitlement. Essentials license entitlement is supported currently.\nlicenseState attribute is used for license enforcement. When license state is one of TrialPeriod, Compliance, or OutOfCompliance,\nthe feature set defined for the license entitlement is granted to the customer.", "x-allOf-name": "license.LicenseInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.LicenseInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.LicenseInfo" ], "default": "license.LicenseInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.LicenseInfo" ], "default": "license.LicenseInfo", "x-enum-as-string": true }, "ActiveAdmin": { "description": "The license administrative state.\nSet this property to 'true' to activate the license entitlements.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Balance": { "description": "The total balance we have for licenses.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DaysLeft": { "description": "The number of days left for licenseState to stay in TrialPeriod or OutOfCompliance state.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "The date and time when the trial period expires.\nThe value of the 'endTime' property is set when the account enters the TrialPeriod or OutOfCompliance state.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "EnforceMode": { "description": "The entitlement mode reported by Cisco Smart Software Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "ErrorDesc": { "description": "The detailed error message when there is any error related to this licensing entitlement.", "type": "string", "readOnly": true, "x-omitempty": true }, "EvaluationPeriod": { "description": "The default Trial or Grace period customer is entitled to.", "type": "integer", "format": "int64", "x-omitempty": true }, "ExpireTime": { "description": "The date and time when the next expiration time of license subscription.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ExtraEvaluation": { "description": "The number of days the trial Trial or Grace period is extended.\nThe trial or grace period can be extended once.", "type": "integer", "format": "int64", "x-omitempty": true }, "LastTrialGraceEvalTime": { "description": "The last time the trial/grace period evaluation was performed for this license.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LicenseCount": { "description": "The total number of license consumed in the Intersight account.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LicenseCountPurchased": { "description": "The total number of license purchased from cisco.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LicenseState": { "description": "The license state defined by Intersight.\nThe value may be one of NotLicensed, TrialPeriod, OutOfCompliance, Compliance, GraceExpired, or TrialExpired.\n* `NotLicensed` - The license token is neither activated nor registered.\n* `GraceExpired` - The license grace period has expired.\n* `TrialPeriod` - The 90 days of trial period.\n* `OutOfCompliance` - The license is out of compliance.\n* `Compliance` - The license is in compliance.\n* `TrialExpired` - The trial period of 90 days has expired.", "type": "string", "enum": [ "NotLicensed", "GraceExpired", "TrialPeriod", "OutOfCompliance", "Compliance", "TrialExpired" ], "default": "NotLicensed", "readOnly": true, "x-omitempty": true }, "LicenseType": { "description": "The name of the Intersight license entitlement.\nFor example, this property may be set to 'Essential'.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "readOnly": true, "x-omitempty": true }, "NetSubstitution": { "description": "The total number of substituted licenses added or removed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "The date and time when the licenseState entered the TrialPeriod or OutOfCompliance state.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "SubscriptionId": { "description": "The id of license subscription.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubstitutedLicense": { "type": "array", "items": { "description": "The substitute license that is used.", "$ref": "#/components/schemas/license.SubstituteLicense", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TrialAdmin": { "description": "The administrative state of the trial license.\nWhen the LicenseState is set to 'NotLicensed', 'trialAdmin' can be set to true to start the trial period,\ni.e. licenseState is set to be TrialPeriod.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.LicenseInfo.List": { "title": "List of 'license.LicenseInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.LicenseInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.LicenseInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseInfo" }, "nullable": true } } } ] }, "license.LicenseInfoView.Response": { "description": "The response body of a HTTP GET request for the 'license.LicenseInfoView' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.LicenseInfoView' resources.", "x-one-of-name": "license.LicenseInfoView.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.LicenseInfoView.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.LicenseInfoView.Relationship": { "description": "A relationship to the 'license.LicenseInfoView' resource, or the expanded 'license.LicenseInfoView' resource, or the 'null' value.", "x-one-of-name": "license.LicenseInfoView.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.LicenseInfoView" } ], "discriminator": { "propertyName": "ClassId" } }, "license.LicenseInfoView": { "title": "License:License Info View", "description": "The LicenseInfoView object provides a custom view for license information, designed to be displayed by user interfaces, enhancing user experience and information accessibility.\n#### Purpose\nLicenseInfoView serves as a presentation layer for license information, offering structured views that enhance the user's ability to access and understand licensing data.\n#### Key Concepts\n- **Custom View Creation:** Facilitates the creation of tailored views for license information, ensuring data is presented in an accessible and user-friendly manner.\n- **UI Integration:** Designed for integration with user interfaces, providing seamless access to licensing data.\n- **Information Accessibility:** Enhances the ability of users to access and interpret license information, supporting informed decision-making.\n- **Organizational Resource:** Operates within shared organizational contexts, ensuring consistent presentation across different accounts and user roles.", "x-allOf-name": "license.LicenseInfoView", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.LicenseInfoView', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.LicenseInfoView" ], "default": "license.LicenseInfoView", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.LicenseInfoView" ], "default": "license.LicenseInfoView", "x-enum-as-string": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.LicenseInfoView.List": { "title": "List of 'license.LicenseInfoView' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.LicenseInfoView' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.LicenseInfoView' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseInfoView" }, "nullable": true } } } ] }, "license.LicenseRegistrationStatus.Response": { "description": "The response body of a HTTP GET request for the 'license.LicenseRegistrationStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.LicenseRegistrationStatus' resources.", "x-one-of-name": "license.LicenseRegistrationStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.LicenseRegistrationStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.LicenseRegistrationStatus.Relationship": { "description": "A relationship to the 'license.LicenseRegistrationStatus' resource, or the expanded 'license.LicenseRegistrationStatus' resource, or the 'null' value.", "x-one-of-name": "license.LicenseRegistrationStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "license.LicenseRegistrationStatus": { "title": "License:License Registration Status", "description": "The LicenseRegistrationStatus object is essential for monitoring the current step of license registration status, offering insights into registration flows and completion states.\n#### Purpose\nLicenseRegistrationStatus provides visibility into the stages of license registration, allowing users to track progress and manage registration flows effectively.\n#### Key Concepts\n- **Registration Monitoring:** Centralizes tracking of registration status, offering insights into current flow and completion stages.\n- **Trial Completion Tracking:** Supports monitoring of trial registration completion, ensuring users can manage trial flows effectively.\n- **Account Status Visibility:** Provides information on new account statuses, supporting UI theme upgrades and user experience enhancements.\n- **Organizational Resource:** Designed to operate within shared organizational contexts, ensuring consistent tracking across different accounts and user roles.", "x-allOf-name": "license.LicenseRegistrationStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.LicenseRegistrationStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.LicenseRegistrationStatus" ], "default": "license.LicenseRegistrationStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.LicenseRegistrationStatus" ], "default": "license.LicenseRegistrationStatus", "x-enum-as-string": true }, "AccountCreationState": { "description": "Stores information on whether account has gone through the registration wizard. True if has not.", "type": "boolean", "x-omitempty": true }, "IsNewAccount": { "description": "Stores information on whether account is new. This data is used for UI theme upgrade, where existing users will be shown a slightly different screen. True if new.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LicenseRegistrationState": { "description": "Stores information on the current flow of license registration.\n* `RegistrationNotStarted` - The license registration state to chose between trial and registration.\n* `RegistrationStarted` - The license registration state during set up flow.\n* `RegistrationComplete` - The license registration state after completion.", "type": "string", "enum": [ "RegistrationNotStarted", "RegistrationStarted", "RegistrationComplete" ], "default": "RegistrationNotStarted", "x-omitempty": true }, "TrialRegistrationComplete": { "description": "Stores information on whether trial flow has been completed. True if trial registration finish.", "type": "boolean", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.LicenseRegistrationStatus.List": { "title": "List of 'license.LicenseRegistrationStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.LicenseRegistrationStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.LicenseRegistrationStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseRegistrationStatus" }, "nullable": true } } } ] }, "license.LicenseReservationOp.Response": { "description": "The response body of a HTTP GET request for the 'license.LicenseReservationOp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.LicenseReservationOp' resources.", "x-one-of-name": "license.LicenseReservationOp.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.LicenseReservationOp.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.LicenseReservationOp": { "title": "License:License Reservation Op", "description": "Customer operation object to request reservation code.", "x-allOf-name": "license.LicenseReservationOp", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.LicenseReservationOp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.LicenseReservationOp" ], "default": "license.LicenseReservationOp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.LicenseReservationOp" ], "default": "license.LicenseReservationOp", "x-enum-as-string": true }, "AuthCode": { "description": "Revervation code used to install the license.", "type": "string", "x-omitempty": true }, "AuthCodeInstalled": { "description": "Flag to indicate whether authorization code is installed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ConfirmCode": { "description": "Confirm code used to complete the license update on smart license account.", "type": "string", "readOnly": true, "x-omitempty": true }, "GenerateRequestCode": { "description": "Trigger the generation of request code for specific license reservation.", "type": "boolean", "x-omitempty": true }, "GenerateReturnCode": { "description": "Trigger the generation of return code for specific license reservation.", "type": "boolean", "x-omitempty": true }, "RequestCode": { "description": "Revervation code used to generate authorization code from CSSM.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReturnCode": { "description": "Return code used to return the reserved license to smart license account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "license.LicenseReservationOp.List": { "title": "List of 'license.LicenseReservationOp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.LicenseReservationOp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.LicenseReservationOp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.LicenseReservationOp" }, "nullable": true } } } ] }, "license.SmartlicenseToken.Response": { "description": "The response body of a HTTP GET request for the 'license.SmartlicenseToken' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'license.SmartlicenseToken' resources.", "x-one-of-name": "license.SmartlicenseToken.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/license.SmartlicenseToken.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "license.SmartlicenseToken.Relationship": { "description": "A relationship to the 'license.SmartlicenseToken' resource, or the expanded 'license.SmartlicenseToken' resource, or the 'null' value.", "x-one-of-name": "license.SmartlicenseToken.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/license.SmartlicenseToken" } ], "discriminator": { "propertyName": "ClassId" } }, "license.SmartlicenseToken": { "title": "License:Smartlicense Token", "description": "The SmartlicenseToken object manages the collection of license registration tokens, ensuring secure and efficient handling of licensing credentials.\n#### Purpose\nSmartlicenseToken serves as the repository for license registration tokens, providing mechanisms for secure storage and retrieval of licensing credentials.\n#### Key Concepts\n- **Token Management:** Centralizes storage and management of license registration tokens, ensuring secure handling of credentials.\n- **Credential Security:** Focuses on the security aspects of token management, ensuring tokens are protected and accessible only to authorized users.\n- **Organizational Resource:** Operates within shared organizational contexts, allowing consistent application across different accounts and user roles.\n- **Integration:** Designed to integrate seamlessly with licensing processes, supporting efficient registration and authorization flows.", "x-allOf-name": "license.SmartlicenseToken", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.SmartlicenseToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.SmartlicenseToken" ], "default": "license.SmartlicenseToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.SmartlicenseToken" ], "default": "license.SmartlicenseToken", "x-enum-as-string": true }, "Token": { "description": "Smart license registration token.", "type": "string", "x-omitempty": true }, "AccountLicenseData": { "$ref": "#/components/schemas/license.AccountLicenseData.Relationship", "description": "A reference to a licenseAccountLicenseData resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "license.SmartlicenseToken.List": { "title": "List of 'license.SmartlicenseToken' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'license.SmartlicenseToken' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'license.SmartlicenseToken' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/license.SmartlicenseToken" }, "nullable": true } } } ] }, "license.SubstituteLicense": { "title": "License:Substitute License", "description": "License tiers can be substituted with higher tiers. Will contain information on the type of license being used\nfor substitution, the number of substutions used, and the substitution type.", "x-allOf-name": "license.SubstituteLicense", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'license.SubstituteLicense', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "license.SubstituteLicense" ], "default": "license.SubstituteLicense", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "license.SubstituteLicense" ], "default": "license.SubstituteLicense", "x-enum-as-string": true }, "SubstitutedLicense": { "description": "The substitute license that is used.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubstitutedQuantity": { "description": "The number of substitute licenses that are used.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SubstitutionType": { "description": "The substitution from lower or from higher tier.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.AccessPrivilege": { "title": "Meta:Access Privilege", "description": "The required access privilege for a given Managed Object and CRUD operation.", "x-allOf-name": "meta.AccessPrivilege", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.AccessPrivilege', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.AccessPrivilege" ], "default": "meta.AccessPrivilege", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.AccessPrivilege" ], "default": "meta.AccessPrivilege", "x-enum-as-string": true }, "Method": { "description": "The type of CRUD operation (create, read, update, delete) for which an access privilege is required.\n* `Update` - The 'update' operation/state.\n* `Create` - The 'create' operation/state.\n* `Read` - The 'read' operation/state.\n* `Delete` - The 'delete' operation/state.", "type": "string", "enum": [ "Update", "Create", "Read", "Delete" ], "default": "Update", "readOnly": true, "x-omitempty": true }, "Privilege": { "description": "The name of the privilege which is required to invoke the specified CRUD method.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.Definition.Response": { "description": "The response body of a HTTP GET request for the 'meta.Definition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'meta.Definition' resources.", "x-one-of-name": "meta.Definition.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/meta.Definition.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "meta.Definition": { "title": "Meta:Definition", "description": "The meta-data of managed objects and complex types.", "x-allOf-name": "meta.Definition", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.Definition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.Definition" ], "default": "meta.Definition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.Definition" ], "default": "meta.Definition", "x-enum-as-string": true }, "AccessPrivileges": { "type": "array", "items": { "description": "The list of access privileges that are required to perform CRUD operations on this managed object. If no access privileges are specified, the object is not accessible.", "$ref": "#/components/schemas/meta.AccessPrivilege", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AncestorClasses": { "type": "array", "items": { "description": "An array of parent metaclasses in the class inheritance hierarchy. The first element in the array is the parent class. The next element is the grand-parent, etc. The last element in the array is the mo.BaseMo class.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DisplayNameMetas": { "type": "array", "items": { "description": "The user appropriate display name meta.", "$ref": "#/components/schemas/meta.DisplayNameDefinition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "EnablePreviousMo": { "description": "When true, MO change events for this type include the previous (old) value of each modified field alongside the new value, so consumers (e.g. post-processing services) can see both. Implemented by enabling MongoDB change stream pre-image snapshots for the collection.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IdentityConstraints": { "type": "array", "items": { "description": "Meta definition for the identity constraints in the meta class.", "$ref": "#/components/schemas/meta.IdentityDefinition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsConcrete": { "description": "Boolean flag to specify whether the meta class is a concrete class or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MetaType": { "description": "Indicates whether the meta class is a complex type or managed object.\n* `ManagedObject` - The meta.Definition object describes a managed object.\n* `ComplexType` - The meta.Definition object describes a nested complex type within a managed object.", "type": "string", "enum": [ "ManagedObject", "ComplexType" ], "default": "ManagedObject", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The fully-qualified class name of the Managed Object or complex type. For example, \"compute:Blade\" where the Managed Object is \"Blade\" and the package is 'compute'.", "type": "string", "readOnly": true, "x-omitempty": true }, "Namespace": { "description": "The namespace of the meta.", "type": "string", "readOnly": true, "x-omitempty": true }, "Owner": { "description": "A value describing the owner for a given Managed Object, such as Account or Organization.\n* `System` - Any Managed Object with OwnerType as System is root for objects common to all accounts. Any object which inherits permissions from this object has owners as system and is common to all accounts. Objects with owner as system can only be read by user and modification is not allowed by user.\n* `Yes` - Any Managed Object with OwnerType as Yes is root for objects which need security filtering. Currently objects with owner yes are account and device registration. Any object with owner ''yes'' has self moid in owners and any objects which inherits permissions from this object has root object moid as owners. In user context, account filtering is enforced by providing access to objects with owner as account moid. In device context, device filtering is enforced by providing access to objects with owner as device moid.\n* `No` - Any Managed Object with OwnerType as No inherits base mo properties like owners, domain group moid, account moid, permission resources from inherit permission relation. Inherit permission relation could be with an object whose owner is system/organization/yes/no.\n* `Internal` - Any Managed Object with OwnerType as Internal is internal to system. Such Managed Objects cannot be accessed using REST APIs and can be created, updated or deleted in any security context.\n* `Organization` - Any Managed Object with OwnerType as Organization is contained under an organization like profiles, policies, user defined workflows. Implicitly an organization on-peer-delete relation is added in this object.", "type": "string", "enum": [ "System", "Yes", "No", "Internal", "Organization" ], "default": "System", "readOnly": true, "x-omitempty": true }, "ParentClass": { "description": "The fully-qualified name of the parent metaclass in the class inheritance hierarchy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PermissionSupported": { "description": "Boolean flag to specify whether instances of this class type can be specified in permissions for instance based access control. Permissions can be created for entire Intersight account or to a subset of resources (instance based access control). In the first release, permissions are supported for entire account or for a subset of organizations.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Properties": { "type": "array", "items": { "description": "Meta definition for the properties in the meta class and from all classes in the inheritance hierarchy.", "$ref": "#/components/schemas/meta.PropDefinition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RbacResource": { "description": "Boolean flag to specify whether instances of this class type can be assigned to resource groups that are part of an organization for access control. Inventoried physical/logical objects which needs access control should have rbacResource=true. These objects are not part of any organization by default like device registrations and should be assigned to organizations for access control. Profiles, policies, workflow definitions which are created by specifying organization need not have this flag set.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Relationships": { "type": "array", "items": { "description": "Meta definition for the relationship in the meta class.", "$ref": "#/components/schemas/meta.RelationshipDefinition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ResourcePoolTypes": { "type": "array", "items": { "description": "A collection of Pool types. When the collection contains any value, it means a ResourcePool of the current MO or its child MO can be created with given Pool type. Consider for example, if there is a requirement to support pool creation for Virtual Machines, then we shall add this property for VirtualMachine MO with an appropriate pool name to represent the Virtual Machine pool in the UI.\nResourcePoolTypes = \"Virtual Machine\"\nThe newly added pool type \"Virtual Machine\" needs to be updated in Malibu's ResourceType enum. While creating the resource pool, UI will list the supported pool types specified in this enum. Once the pool type is selected, the MOs updated with the matching ResourcePoolType property will be listed for selection to create the pool.\nThe same ResourcePoolType name can be used for more than one MOs. Consider as an example, RackUnit and Blade MOs can be grouped under a pool type called 'Server'. Also this can be used at abstract class as well. For example, compute.Physical is abstract class for compute.RackUnit and compute.Blade; so, instead of adding this property at compute.Blade and compute.RackUnit, it can be added at abstract class level, which is compute.Physical.\nResourcePoolTypes property of an MO can hold one or more values. Consider compute.RackUnit MO can be considered for creating two distinct type of pools - say, Server Pool and Rack Server Pool. In this case, we need to update the ResourcePoolTypes property as below:\nResourcePoolTypes = \"Server, Rack Server\".", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RestPath": { "description": "Restful URL path for the meta.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the service that defines the meta-data.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.Definition.List": { "title": "List of 'meta.Definition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'meta.Definition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'meta.Definition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/meta.Definition" }, "nullable": true } } } ] }, "meta.DisplayNameDefinition": { "title": "Meta:Display Name Definition", "description": "A rule for constructing user appropriate names for MO instances using the fields of the MO instance and MOs in its Ancestors hierarchy.", "x-allOf-name": "meta.DisplayNameDefinition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.DisplayNameDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.DisplayNameDefinition" ], "default": "meta.DisplayNameDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.DisplayNameDefinition" ], "default": "meta.DisplayNameDefinition", "x-enum-as-string": true }, "Format": { "description": "A specification for constructing the displayname from the MO's properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "IncludeAncestor": { "description": "An indication of whether the displayname should be contructed 'recursively' including the displayname of the first ancestor with a similarly named displayname.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the displayname used as a key in the DisplayName map which is returned as part of an MO for a Rest request.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.IdentityDefinition": { "title": "Meta:Identity Definition", "description": "Definitions for the identity constraints in meta.", "x-allOf-name": "meta.IdentityDefinition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.IdentityDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.IdentityDefinition" ], "default": "meta.IdentityDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.IdentityDefinition" ], "default": "meta.IdentityDefinition", "x-enum-as-string": true }, "Fields": { "type": "array", "items": { "description": "Array of fields that uniquely identify the managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "meta.PropDefinition": { "title": "Meta:Prop Definition", "description": "Definitions for the properties in a meta.", "x-allOf-name": "meta.PropDefinition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.PropDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.PropDefinition" ], "default": "meta.PropDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.PropDefinition" ], "default": "meta.PropDefinition", "x-enum-as-string": true }, "ApiAccess": { "description": "API access control for the property. Examples are NoAccess, ReadOnly, CreateOnly etc.\n* `NoAccess` - The property is not accessible from the API.\n* `ReadOnly` - The value of the property is read-only.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa ReadOnly property.\n* `CreateOnly` - The value of the property can be set when the REST resource is created. It cannot be changed after object creation.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa CreateOnly property.CreateOnly properties are returned in the response body of HTTP GET requests.\n* `ReadWrite` - The property has read/write access.\n* `WriteOnly` - The value of the property can be set but it is never returned in the response body of supported HTTP methods.This settings is used for sensitive properties such as passwords.\n* `ReadOnCreate` - The value of the property is returned in the HTTP POST response body when the REST resource is created.The property is not writeable and cannot be queried through a GET request after the resource has been created.", "type": "string", "enum": [ "NoAccess", "ReadOnly", "CreateOnly", "ReadWrite", "WriteOnly", "ReadOnCreate" ], "default": "NoAccess", "readOnly": true, "x-omitempty": true }, "Default": { "description": "The default value of the property. Not applicable when IsComplexType is True.", "nullable": true, "readOnly": true, "x-omitempty": true }, "IsCollection": { "description": "Indicates whether the property is a collection (i.e. a JSON array), otherwise it is a single value.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsComplexType": { "description": "Indicates whether the property is a complex type, otherwise it is a basic scalar type.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Kind": { "description": "The kind of the property.\n* `Unknown` - The property kind is unknown.\n* `Boolean` - The 'Boolean' kind of property.\n* `String` - The 'String' kind of property.\n* `Integer` - The 'Integer' kind of property.\n* `Int32` - The 'Int32' kind of property.\n* `Int64` - The 'Int64' kind of property.\n* `Float` - The 'Float' kind of property.\n* `Double` - The 'Double' kind of property.\n* `Date` - The 'Date' kind of property.\n* `Duration` - The 'Duration' kind of property.\n* `Time` - The 'Time' kind of property.\n* `Json` - The 'JSON' kind of property.\n* `Binary` - The 'Binary' kind of property.\n* `EnumString` - The 'EnumString' kind of property.\n* `EnumInteger` - The 'EnumInteger' kind of property.\n* `ComplexType` - The 'ComplexType' kind of property.", "type": "string", "enum": [ "Unknown", "Boolean", "String", "Integer", "Int32", "Int64", "Float", "Double", "Date", "Duration", "Time", "Json", "Binary", "EnumString", "EnumInteger", "ComplexType" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the property.", "type": "string", "readOnly": true, "x-omitempty": true }, "OpSecurity": { "description": "The data-at-rest security protection applied to this property when a Managed Object is persisted.\nFor example, Encrypted or Cleartext.\n* `ClearText` - Data at rest is not encrypted using account specific keys.Note that data is always protected using volume encryption. ClearText propertiesare queryable and searchable.\n* `Encrypted` - The value of the property is encrypted with account-specific cryptographic keys.This setting is used for properties that contain sensitive data. Encrypted propertiesare not queryable and searchable.\n* `Pbkdf2` - The value of the property is hashed using the pbkdf2 key derivation functions thattakes a password, a salt, and a cost factor as inputs then generates a password hash.Its purpose is to make each password guessing trial by an attacker who has obtaineda password hash file expensive and therefore the cost of a guessing attack high or prohibitive.\n* `Bcrypt` - The value of the property is hashed using the bcrypt key derivation function.\n* `Sha512crypt` - The value of the property is hashed using the sha512crypt key derivation function.\n* `Argon2id` - The value of the property is hashed using the argon2id key derivation function.", "type": "string", "enum": [ "ClearText", "Encrypted", "Pbkdf2", "Bcrypt", "Sha512crypt", "Argon2id" ], "default": "ClearText", "readOnly": true, "x-omitempty": true }, "SearchWeight": { "description": "Enables the property to be searchable from global search. A value of 0 means this property is not globally searchable.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the property. In case of collection properties the type is that of individual elements.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "meta.RelationshipDefinition": { "title": "Meta:Relationship Definition", "description": "Definitions for the relationship in a meta.", "x-allOf-name": "meta.RelationshipDefinition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'meta.RelationshipDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "meta.RelationshipDefinition" ], "default": "meta.RelationshipDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "meta.RelationshipDefinition" ], "default": "meta.RelationshipDefinition", "x-enum-as-string": true }, "ApiAccess": { "description": "API access definition for this relationship.\n* `NoAccess` - The property is not accessible from the API.\n* `ReadOnly` - The value of the property is read-only.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa ReadOnly property.\n* `CreateOnly` - The value of the property can be set when the REST resource is created. It cannot be changed after object creation.An HTTP 4xx status code is returned when the user sends a POST/PUT/PATCH request that containsa CreateOnly property.CreateOnly properties are returned in the response body of HTTP GET requests.\n* `ReadWrite` - The property has read/write access.\n* `WriteOnly` - The value of the property can be set but it is never returned in the response body of supported HTTP methods.This settings is used for sensitive properties such as passwords.\n* `ReadOnCreate` - The value of the property is returned in the HTTP POST response body when the REST resource is created.The property is not writeable and cannot be queried through a GET request after the resource has been created.", "type": "string", "enum": [ "NoAccess", "ReadOnly", "CreateOnly", "ReadWrite", "WriteOnly", "ReadOnCreate" ], "default": "NoAccess", "readOnly": true, "x-omitempty": true }, "Collection": { "description": "Specifies whether the relationship is a collection.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Export": { "description": "When turned off, the peer MO is not exported when the local MO is exported.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ExportWithPeer": { "description": "When turned on, the local MO is exported when the peer is exported.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the relationship.", "type": "string", "readOnly": true, "x-omitempty": true }, "OnDelete": { "description": "The action to perform on the peer MO when the local MO is deleted.\n* `Unset` - Any relationship from the peer managed object to the managed object being deleted is unset.\n* `Cascade` - The peer managed object is deleted.\n* `Prohibit` - The deletion is prevented when the relationship is set.\n* `Ignore` - No action is performed on the relationship value or the peer managed object of the relationship.", "type": "string", "enum": [ "Unset", "Cascade", "Prohibit", "Ignore" ], "default": "Unset", "readOnly": true, "x-omitempty": true }, "OnPeerDelete": { "description": "The action to perform on the local MO when the peer MO is deleted.\n* `Unset` - Any relationship from the peer managed object to the managed object being deleted is unset.\n* `Cascade` - The peer managed object is deleted.\n* `Prohibit` - The deletion is prevented when the relationship is set.\n* `Ignore` - No action is performed on the relationship value or the peer managed object of the relationship.", "type": "string", "enum": [ "Unset", "Cascade", "Prohibit", "Ignore" ], "default": "Unset", "readOnly": true, "x-omitempty": true }, "PeerRelName": { "description": "Name of relationship in peer managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "PeerSupportedObjectTypes": { "type": "array", "items": { "description": "The list of supported object types for the peer MO.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PeerSync": { "description": "When turned on, peer MO corresponding to the reference provided in relation is updated with a reference to the current MO.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Fully qualified type of the peer managed object.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "metric.SeverityCriteria": { "title": "Metric:Severity Criteria", "description": "Defines how different levels of alarm severity correspond to specific threshold values for metrics.", "x-allOf-name": "metric.SeverityCriteria", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'metric.SeverityCriteria', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "metric.SeverityCriteria" ], "default": "metric.SeverityCriteria", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "metric.SeverityCriteria" ], "default": "metric.SeverityCriteria", "x-enum-as-string": true }, "Operator": { "description": "The comparison operator that evaluates the metric value against the threshold.\n* `greaterThan` - This checks if the metric value is greater than the threshold value.\n* `lessThan` - This checks if the metric value is less than the threshold value.", "type": "string", "enum": [ "greaterThan", "lessThan" ], "default": "greaterThan", "x-omitempty": true }, "Severity": { "description": "The severity of the alarm.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "x-omitempty": true }, "ThresholdValue": { "description": "The threshold value of the metric for the corresponding severity.", "type": "string", "x-omitempty": true } } } ] }, "metric.ThresholdCondition": { "title": "Metric:Threshold Condition", "description": "The criteria set by the user to identify issue in timeseries metric data.", "x-allOf-name": "metric.ThresholdCondition", "allOf": [ { "$ref": "#/components/schemas/issue.Condition" }, { "type": "object", "description": "Definition of the list of properties defined in 'metric.ThresholdCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "metric.ThresholdCondition" ], "default": "metric.ThresholdCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "metric.ThresholdCondition" ], "default": "metric.ThresholdCondition", "x-enum-as-string": true }, "Filters": { "type": "array", "items": { "description": "The filters to be applied on the metric.", "$ref": "#/components/schemas/cond.FilterRule", "x-omitempty": true }, "nullable": true }, "Granularity": { "description": "Defines the interval at which alarm condition is evaluated.\n* `PT10M` - Duration of 10 minutes in the ISO 8601 duration format.\n* `PT1M` - Duration of 1 minute in the ISO 8601 duration format.\n* `PT30M` - Duration of 30 minutes in the ISO 8601 duration format.\n* `PT1H` - Duration of 1 hour in the ISO 8601 duration format.", "type": "string", "enum": [ "PT10M", "PT1M", "PT30M", "PT1H" ], "default": "PT10M", "x-omitempty": true }, "GroupBy": { "description": "A set of metric attributes used for grouping the metric data. Currently, this can be the 'id' or 'host.id' attributes, as alarms must be generated for Intersight-managed object.\n* `host.id` - The API path of the host associated with the resource component for which the metric is reported.\n* `id` - The API path of the resource component for which the metric is reported.", "type": "string", "enum": [ "host.id", "id" ], "default": "host.id", "x-omitempty": true }, "InstrumentName": { "description": "The instrument to which the metric belongs to.", "type": "string", "x-omitempty": true }, "MetricName": { "description": "The metric on which condition is specified.", "type": "string", "x-omitempty": true }, "RollUpAggregate": { "description": "Aggregation function to be applied to the grouped metric values. Example - \"Avg\" network utilization across all uplink ports in FI.\n* `Last` - Last value observed within a time duration - for example, last temperature reading.\n* `Average` - Arithmetic mean of the metric measurements collected over time, calculated as the sum of all metric measurements divided by the count. For example - Average temperature over time.\n* `AverageRate` - Rate of the metric measurements collected over time, calculated as the sum of all metric measurements divided by the duration of collection. For example - Average rate of network CRC errors over time.\n* `Minimum` - Smallest of all the metric values collected over time.\n* `MinimumRate` - Smallest of all the metric rate values collected over time.\n* `Maximum` - Maximum of all metric values collected over time.\n* `MaximumRate` - Maximum of all the metric rate values collected over time.\n* `Sum` - Sum of the metric values, like energy consumed over time.\n* `SumRate` - Sum of the metric rate values over time.", "type": "string", "enum": [ "Last", "Average", "AverageRate", "Minimum", "MinimumRate", "Maximum", "MaximumRate", "Sum", "SumRate" ], "default": "Last", "x-omitempty": true }, "SeverityCriteria": { "type": "array", "items": { "description": "Defines the various alarm severity criteria based on the threshold value.", "$ref": "#/components/schemas/metric.SeverityCriteria", "x-omitempty": true }, "minItems": 1, "maxItems": 2, "nullable": true }, "TotalDataPoints": { "description": "Total number of data points for which the alarm should be evaluated for this condition.", "type": "integer", "format": "int64", "minimum": 1, "x-omitempty": true }, "TriggerCount": { "description": "The minimum number of instances that must satisfy the alarm criteria.", "type": "integer", "format": "int64", "minimum": 1, "x-omitempty": true } } } ] }, "metric.ThresholdDefinitionState": { "title": "Metric:Threshold Definition State", "description": "Defines the state of metric related ThresholdDefinition objects, enabling alarm processing to be customized according to the specific needs.", "x-allOf-name": "metric.ThresholdDefinitionState", "allOf": [ { "$ref": "#/components/schemas/cond.ThresholdDefinitionState" }, { "type": "object", "description": "Definition of the list of properties defined in 'metric.ThresholdDefinitionState', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "metric.ThresholdDefinitionState" ], "default": "metric.ThresholdDefinitionState", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "metric.ThresholdDefinitionState" ], "default": "metric.ThresholdDefinitionState", "x-enum-as-string": true }, "Enabled": { "description": "Controls the behavior of alarm processing based on the criteria set for this metric. If set to true which is also the default behavior, the alarm is evaluated against the criteria set for the metric. If set to false, the alarm is not evaluated, and any existing alarms triggered by the criteria set for the metric are cleared.", "type": "boolean", "default": true, "x-omitempty": true }, "InstrumentName": { "description": "The instrument to which the metric belongs to.", "type": "string", "x-omitempty": true }, "MetricName": { "description": "The metric for which rule is specified.", "type": "string", "x-omitempty": true } } } ] }, "metrics.Configuration.Response": { "description": "The response body of a HTTP GET request for the 'metrics.Configuration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'metrics.Configuration' resources.", "x-one-of-name": "metrics.Configuration.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/metrics.Configuration.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "metrics.Configuration": { "title": "Metrics:Configuration", "description": "Controls the behavior of metric collection for an account, configuration includes options to enable or disable collection as well how new devices claimed to the account are handled.", "x-allOf-name": "metrics.Configuration", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'metrics.Configuration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "metrics.Configuration" ], "default": "metrics.Configuration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "metrics.Configuration" ], "default": "metrics.Configuration", "x-enum-as-string": true }, "CollectNewDevices": { "description": "The behavior of the system when new resources are added, controls whether metric collection are automatically enabled for the new resources.\n* `AutoEnable` - Automatically enable metric collection for new resources, up to the limit of resource collection.\n* `Disabled` - Metrics will not be enabled on new resources, to enable collection requires an explicit user enable.", "type": "string", "enum": [ "AutoEnable", "Disabled" ], "default": "AutoEnable", "x-omitempty": true }, "CollectionGranularity": { "description": "The current supported collection granularity by the system, defined as the lowest granularity supported, with the actual granularity per resource determined by the license tier of the resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Enables metric collection for the account, if disabled metrics will be stopped for all resources in the account.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Limit": { "description": "The total number of resources that can be enabled for metric collection in this account.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UserMaxIngestionBytes": { "description": "User override of the max ingestion rate for metrics. Provided as an advanced option to override the default limits. Option should only be used in coordination with TAC engineers.", "type": "integer", "format": "int64", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "metrics.Configuration.List": { "title": "List of 'metrics.Configuration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'metrics.Configuration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'metrics.Configuration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/metrics.Configuration" }, "nullable": true } } } ] }, "metrics.MetricCriterion": { "title": "Metrics:Metric Criterion", "description": "Data and parameters for metric configuration.", "x-allOf-name": "metrics.MetricCriterion", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'metrics.MetricCriterion', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "metrics.MetricCriterion" ], "default": "metrics.MetricCriterion", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "metrics.MetricCriterion" ], "default": "metrics.MetricCriterion", "x-enum-as-string": true }, "Aggregation": { "description": "Function name for combining group buckets into a single timeseries.", "type": "string", "x-omitempty": true }, "Filters": { "type": "array", "items": { "description": "Criteria for determining which data rows are included in the query computation.", "type": "string", "x-omitempty": true }, "nullable": true }, "Groups": { "type": "array", "items": { "description": "Attribute names for metrics grouping.", "type": "string", "x-omitempty": true }, "nullable": true }, "Instrument": { "description": "Instrument name for measurement collection in the query.", "type": "string", "x-omitempty": true }, "IsEnabled": { "description": "Flag indicating if this criterion should be used for the query.", "type": "boolean", "x-omitempty": true }, "Metric": { "description": "Measurement name for instrument collection in the query.", "type": "string", "x-omitempty": true }, "MetricAggregation": { "description": "Function name for combining metrics into granularity buckets.", "type": "string", "x-omitempty": true }, "TopLimit": { "description": "Maximum number of rows in the result.", "type": "integer", "format": "int64", "x-omitempty": true }, "TopSort": { "description": "Method for sorting the result rows.", "type": "string", "x-omitempty": true } } } ] }, "metrics.MetricsExploration.Response": { "description": "The response body of a HTTP GET request for the 'metrics.MetricsExploration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'metrics.MetricsExploration' resources.", "x-one-of-name": "metrics.MetricsExploration.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/metrics.MetricsExploration.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "metrics.MetricsExploration": { "title": "Metrics:Metrics Exploration", "description": "The MetricsExploration object is pivotal for querying and analyzing metrics data within the system. This provides a structured approach to defining and executing metrics queries for data exploration and visualization.\n#### Purpose\nMetricsExploration enables users to define complex queries and visualize metrics data for deeper analysis and actionable insights. It supports interactive, user-driven exploration to identify trends, patterns, and opportunities for data-driven decisions.\n#### Key Concepts\n- **Flexible Querying:** Supports a wide range of query configurations and criteria, allowing users to tailor their metrics exploration.\n- **Visualization Options:** Offers diverse visualization configurations, enhancing the interpretability and presentation of metrics data.\n- **Access Control:** Provides controlled access to metrics data queries, ensuring secure and authorized exploration by privileged users.", "x-allOf-name": "metrics.MetricsExploration", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'metrics.MetricsExploration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "metrics.MetricsExploration" ], "default": "metrics.MetricsExploration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "metrics.MetricsExploration" ], "default": "metrics.MetricsExploration", "x-enum-as-string": true }, "Description": { "description": "User specified description of the MetricsExploration.", "type": "string", "x-omitempty": true }, "Granularity": { "description": "Time unit for aggregating the metrics.", "type": "string", "x-omitempty": true }, "Intervals": { "type": "array", "items": { "description": "Time range for metric return.", "type": "string", "x-omitempty": true }, "nullable": true }, "IsWidget": { "description": "Set to true when the MetricsExploration is presented as a Dashlet widget.", "type": "boolean", "x-omitempty": true }, "MetricCriteria": { "type": "array", "items": { "description": "List of MetricCriterion created by the user.", "$ref": "#/components/schemas/metrics.MetricCriterion", "x-omitempty": true }, "nullable": true }, "Name": { "description": "User specified name of the MetricsExploration.", "type": "string", "x-omitempty": true }, "RawQueries": { "type": "array", "items": { "description": "Raw druid query associated with the MetricsExploration.", "type": "string", "x-omitempty": true }, "nullable": true }, "VisualConfig": { "description": "Chart configuration options.", "nullable": true, "x-omitempty": true }, "Organization": { "$ref": "#/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 } } } ] }, "metrics.MetricsExploration.List": { "title": "List of 'metrics.MetricsExploration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'metrics.MetricsExploration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'metrics.MetricsExploration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/metrics.MetricsExploration" }, "nullable": true } } } ] }, "metrics.ResourceConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'metrics.ResourceConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'metrics.ResourceConfiguration' resources.", "x-one-of-name": "metrics.ResourceConfiguration.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/metrics.ResourceConfiguration.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "metrics.ResourceConfiguration": { "title": "Metrics:Resource Configuration", "description": "The configuration of metric collection for a given resource within an account. Each resource that is capable of collecting metrics into the Intersight system may be configured with options to control the metric collection behavior.", "x-allOf-name": "metrics.ResourceConfiguration", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'metrics.ResourceConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "metrics.ResourceConfiguration" ], "default": "metrics.ResourceConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "metrics.ResourceConfiguration" ], "default": "metrics.ResourceConfiguration", "x-enum-as-string": true }, "Enabled": { "description": "Metric collection is enabled for this resource, when enabled all available metrics are collected from the resource into Intersight.", "type": "boolean", "x-omitempty": true }, "Domain": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "#/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 } } } ] }, "metrics.ResourceConfiguration.List": { "title": "List of 'metrics.ResourceConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'metrics.ResourceConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'metrics.ResourceConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/metrics.ResourceConfiguration" }, "nullable": true } } } ] }, "mgmt.BackupCategory.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.BackupCategory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.BackupCategory' resources.", "x-one-of-name": "mgmt.BackupCategory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.BackupCategory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.BackupCategory.Relationship": { "description": "A relationship to the 'mgmt.BackupCategory' resource, or the expanded 'mgmt.BackupCategory' resource, or the 'null' value.", "x-one-of-name": "mgmt.BackupCategory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/mgmt.BackupCategory" } ], "discriminator": { "propertyName": "ClassId" } }, "mgmt.BackupCategory": { "title": "Mgmt:Backup Category", "description": "Meta data information used by the backup service to classify backup of MO types.", "x-allOf-name": "mgmt.BackupCategory", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.BackupCategory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.BackupCategory" ], "default": "mgmt.BackupCategory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.BackupCategory" ], "default": "mgmt.BackupCategory", "x-enum-as-string": true }, "Name": { "description": "The name of the category.", "type": "string", "readOnly": true, "x-omitempty": true }, "Order": { "description": "The precedence or order for this category during backup operations is captured in the order property. The order will be applied within the context of the containment scope.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ReportingServices": { "type": "array", "items": { "description": "The list of services that have reported this category.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Scope": { "description": "The containment scope to be used for this category of objects.\n* `Account` - The objects are present at the account level.\n* `Organization` - The objects are present within the context of an organization.", "type": "string", "enum": [ "Account", "Organization" ], "default": "Account", "readOnly": true, "x-omitempty": true } } } ] }, "mgmt.BackupCategory.List": { "title": "List of 'mgmt.BackupCategory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.BackupCategory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.BackupCategory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.BackupCategory" }, "nullable": true } } } ] }, "mgmt.BackupOptions": { "title": "Mgmt:Backup Options", "description": "Options to control the behavior of a backup operation.", "x-allOf-name": "mgmt.BackupOptions", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.BackupOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.BackupOptions" ], "default": "mgmt.BackupOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.BackupOptions" ], "default": "mgmt.BackupOptions", "x-enum-as-string": true }, "AutoRollover": { "description": "If enabled and the limit on the number of backups per account has been reached, the system would attempt to clear space by removing the oldest backup instance as part of the backup operation.\nIf disabled and the limit has been reached, the request to create a backup operation would fail.", "type": "boolean", "x-omitempty": true }, "PreserveIdentities": { "description": "Backup all identities derived from pools.", "type": "boolean", "x-omitempty": true } } } ] }, "mgmt.CategoryExportData": { "title": "Mgmt:Category Export Data", "description": "Information regarding export jobs that are triggered for a category of objects.", "x-allOf-name": "mgmt.CategoryExportData", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.CategoryExportData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.CategoryExportData" ], "default": "mgmt.CategoryExportData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.CategoryExportData" ], "default": "mgmt.CategoryExportData", "x-enum-as-string": true }, "ExportJobs": { "type": "array", "items": { "description": "List of export jobs triggered for this category.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "Name of the backup category.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProcessedTypes": { "type": "array", "items": { "description": "The list of object types that were processed while creating the backup for this category along with the filter used to obtain the list of objects.", "$ref": "#/components/schemas/mgmt.TypeWithFilter", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "mgmt.CategoryImportData": { "title": "Mgmt:Category Import Data", "description": "Information regarding import jobs that are triggered for a category of objects.", "x-allOf-name": "mgmt.CategoryImportData", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.CategoryImportData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.CategoryImportData" ], "default": "mgmt.CategoryImportData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.CategoryImportData" ], "default": "mgmt.CategoryImportData", "x-enum-as-string": true }, "FileName": { "description": "Name of the file that contains configurations for this category.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the backup category.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProcessedTypes": { "type": "array", "items": { "description": "The list of object types that were processed while creating the backup for this category along with the filter used to obtain the list of objects.", "$ref": "#/components/schemas/mgmt.TypeWithFilter", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Status": { "description": "Import status for this category of objects.\n* `Scheduled` - Backup or restore process has been scheduled.\n* `NotInitiated` - Backup or restore process has not been initiated.\n* `InProgress` - Backup or restore process is in progress.\n* `Failed` - Backup or restore process has failed.\n* `Completed` - Backup or restore process has completed.\n* `NotComplete` - Backup or restore process has partially imported configuration.", "type": "string", "enum": [ "Scheduled", "NotInitiated", "InProgress", "Failed", "Completed", "NotComplete" ], "default": "Scheduled", "readOnly": true, "x-omitempty": true } } } ] }, "mgmt.ChildTypeInfo": { "title": "Mgmt:Child Type Info", "description": "Child type information for a parent type.", "x-allOf-name": "mgmt.ChildTypeInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ChildTypeInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ChildTypeInfo" ], "default": "mgmt.ChildTypeInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ChildTypeInfo" ], "default": "mgmt.ChildTypeInfo", "x-enum-as-string": true }, "ChildTypes": { "type": "array", "items": { "description": "A list with information about types contained under this object type and processed during the backup operation of this type.", "$ref": "#/components/schemas/mgmt.ChildTypeInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "The name of the child MO type.", "type": "string", "readOnly": true, "x-omitempty": true }, "ParentRelationName": { "description": "The name of the relationship to the parent type.", "type": "string", "readOnly": true, "x-omitempty": true }, "RestPath": { "description": "The rest path for the child MO type.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "mgmt.ConfigBackupFile.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.ConfigBackupFile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.ConfigBackupFile' resources.", "x-one-of-name": "mgmt.ConfigBackupFile.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.ConfigBackupFile.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.ConfigBackupFile.Relationship": { "description": "A relationship to the 'mgmt.ConfigBackupFile' resource, or the expanded 'mgmt.ConfigBackupFile' resource, or the 'null' value.", "x-one-of-name": "mgmt.ConfigBackupFile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/mgmt.ConfigBackupFile" } ], "discriminator": { "propertyName": "ClassId" } }, "mgmt.ConfigBackupFile": { "title": "Configuration Backup File", "description": "A configuration backup file that user can upload in Intersight so that the uploaded backup can be restored in Intersight when needed.", "x-allOf-name": "mgmt.ConfigBackupFile", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.File" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigBackupFile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigBackupFile" ], "default": "mgmt.ConfigBackupFile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigBackupFile" ], "default": "mgmt.ConfigBackupFile", "x-enum-as-string": true }, "ConfigurationFileUploadId": { "description": "A unique tracking ID for the file being uploaded.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "mgmt.ConfigBackupFile.List": { "title": "List of 'mgmt.ConfigBackupFile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.ConfigBackupFile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.ConfigBackupFile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.ConfigBackupFile" }, "nullable": true } } } ] }, "mgmt.ConfigBackupInstance.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.ConfigBackupInstance' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.ConfigBackupInstance' resources.", "x-one-of-name": "mgmt.ConfigBackupInstance.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.ConfigBackupInstance.Relationship": { "description": "A relationship to the 'mgmt.ConfigBackupInstance' resource, or the expanded 'mgmt.ConfigBackupInstance' resource, or the 'null' value.", "x-one-of-name": "mgmt.ConfigBackupInstance.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance" } ], "discriminator": { "propertyName": "ClassId" } }, "mgmt.ConfigBackupInstance": { "title": "Mgmt:Config Backup Instance", "description": "The ConfigBackupInstance object represents a stored backup artifact in the system repository. It is the consumable backup unit that can be protected, downloaded, and later used as a restore source.\n#### Purpose\nConfigBackupInstance exists to provide a durable, managed representation of a backup file produced by a backup operation (or created from an imported file). It is the primary object customers interact with when securing and retrieving backup archives.\n#### Key Concepts\n- **Repository-Backed Artifact:** Represents a backup stored in the system, including its readiness and usability for restore operations.\n- **Controlled Download Workflow:** Supports generating short-lived download URLs and managing the actions required to prepare the archive for retrieval.\n- **Encryption Enablement:** Designed to support customer-controlled encryption flows prior to download, enabling stronger handling of backup confidentiality.\n- **Enable Retention:** Provides retention locking to prevent deletion and rollover, supporting compliance-oriented backup handling.\n- **Operational Status Signaling:** Exposes clear state transitions (e.g., ready, corrupted, encryption states) so customers can automate decisions around backup usage.", "x-allOf-name": "mgmt.ConfigBackupInstance", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigBackupInstance', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigBackupInstance" ], "default": "mgmt.ConfigBackupInstance", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigBackupInstance" ], "default": "mgmt.ConfigBackupInstance", "x-enum-as-string": true }, "AdminAction": { "description": "Action to be performed on the backup instance.\n* `None` - Nothing to be done. The default state of the backup instance when there is no action to be performed.\n* `EncryptWithPublicKey` - Encrypt the backup using the user given public key and make it available for download.\n* `EncryptWithPassword` - Encrypt the backup using the user provided password and make it available for download.\n* `GenerateDownloadUrl` - Generate a pre-signed URL that can be used to download a backup archive.", "type": "string", "enum": [ "None", "EncryptWithPublicKey", "EncryptWithPassword", "GenerateDownloadUrl" ], "default": "None", "x-omitempty": true }, "BackupCreationTime": { "description": "The time at which the backup file was created.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "BackupName": { "description": "Name of the backup for which the backup instance is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupSource": { "description": "Indicates whether the backup was created locally or imported.\n* `Local` - A local Intersight location.\n* `Uploaded` - A local location where the backup file is uploaded as mgmt.ConfigBackupFile MO. Intersight creates the backup from the uploaded location when this location type is set.\n* `Remote` - A remote location hosted in the user's datacenter.", "type": "string", "enum": [ "Local", "Uploaded", "Remote" ], "default": "Local", "readOnly": true, "x-omitempty": true }, "Checksum": { "description": "SHA-256 checksum of the encrypted backup archive, returned as a hex-encoded string. Users can compare the checksum of a downloaded archive with this value to verify file integrity and confirm the archive was not corrupted or altered in transit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Description of the backup operation that created this instance.", "type": "string", "x-omitempty": true }, "DownloadUrl": { "description": "Pre-signed URL that can be used to download the backup archive. This URL is generated when the adminAction is set to GenerateDownloadUrl. The URL is valid for 5 minutes.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsUserPasswordSet": { "description": "Indicates whether the value of the 'userPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Path": { "description": "Path to the backup file in the Intersight repository.", "type": "string", "readOnly": true, "x-omitempty": true }, "PreserveIdentities": { "description": "The flag set by the user during a configuration backup to preserve static or dynamic IDs assigned to an export item.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "RetentionLock": { "description": "When set, ensures that the backup archive is protected from deletion and rollover operations.", "type": "boolean", "x-omitempty": true }, "Size": { "description": "Size of the backup instance, represents size of the compressed backup file.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SourceAccountMoid": { "description": "The moid of the account from which the backup was taken.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceName": { "description": "The name of the account from which the backup was taken.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the backup instance.\n* `Unknown` - The status is not known. When the backup instances are created, they are in this state until the backup is ready.\n* `Ready` - Ready for use in an import operation.\n* `RemovalInProgress` - The backup is being removed.\n* `Corrupted` - The backup is corrupted and is not usable.\n* `EncryptionInProgress` - The backup is being encrypted using the user provided public key.\n* `EncryptionFailed` - The backup could not be encrypted using the user provided public key.\n* `Encrypted` - The backup has been encrypted using the user provided public key.", "type": "string", "enum": [ "Unknown", "Ready", "RemovalInProgress", "Corrupted", "EncryptionInProgress", "EncryptionFailed", "Encrypted" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "SystemAdminTriggered": { "description": "Set when a system administrator initiated the backup operation.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "UserPassword": { "description": "The password provided by the user to encrypt the backup before download. This password is not persisted in Intersight and this field will be reset after the backup archive is encrypted. The password encrypts the backup file before download. The user needs to provide the same password to decrypt when they upload the backup file to restore.", "type": "string", "pattern": "^$|^[a-zA-Z0-9=!&#$%+^@_*-]+$", "minLength": 8, "maxLength": 127, "writeOnly": true, "x-omitempty": true }, "UserPublicKey": { "description": "The public key provided by the user to encrypt the backup before download. The key needs to be in PKCS#1 format encoded in PEM.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "mgmt.ConfigBackupInstance.List": { "title": "List of 'mgmt.ConfigBackupInstance' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.ConfigBackupInstance' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.ConfigBackupInstance' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance" }, "nullable": true } } } ] }, "mgmt.ConfigBackupOperation.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.ConfigBackupOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.ConfigBackupOperation' resources.", "x-one-of-name": "mgmt.ConfigBackupOperation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.ConfigBackupOperation.Relationship": { "description": "A relationship to the 'mgmt.ConfigBackupOperation' resource, or the expanded 'mgmt.ConfigBackupOperation' resource, or the 'null' value.", "x-one-of-name": "mgmt.ConfigBackupOperation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation" } ], "discriminator": { "propertyName": "ClassId" } }, "mgmt.ConfigBackupOperation": { "title": "Mgmt:Config Backup Operation", "description": "The ConfigBackupOperation object represents an administrator-initiated configuration backup run. This provides a single, traceable record for when a backup was requested, how it was executed, and how its progress and completion are tracked end-to-end.\n#### Purpose\nConfigBackupOperation exists to orchestrate and audit the lifecycle of creating a configuration backup for an account. It acts as the top-level container that coordinates organization-level and account-level export activities and ties them to a resulting backup artifact.\n#### Key Concepts\n- **Lifecycle Tracking:** Captures the operational state of a backup from initiation through completion, enabling status-based monitoring and user visibility.\n- **Account-Scoped Execution:** Runs within a specific account context, ensuring backups align with tenant boundaries and permissions.\n- **Coordinated Export Workflow:** Aggregates export activity metadata so customers can understand what was included and which export jobs were triggered.\n- **Retention and Rollover Awareness:** Supports controlled space management via rollover behavior and retention protection, enabling predictable backup management at scale.\n- **Artifact Association:** Links the operation to the backup instance produced (the durable item used for download and restore workflows).", "x-allOf-name": "mgmt.ConfigBackupOperation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigBackupOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigBackupOperation" ], "default": "mgmt.ConfigBackupOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigBackupOperation" ], "default": "mgmt.ConfigBackupOperation", "x-enum-as-string": true }, "BackupAccount": { "description": "The moid of the account from which the backup was taken.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupAccountDomainGroupMoid": { "description": "The domain group moid of the account from which the backup was taken.", "type": "string", "readOnly": true, "x-omitempty": true }, "CategoryExportData": { "type": "array", "items": { "description": "The export operations in which configurations under the account are exported.", "$ref": "#/components/schemas/mgmt.CategoryExportData", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Description": { "description": "Description of the backup operation.", "type": "string", "x-omitempty": true }, "Destination": { "description": "Indicates whether the backup was created locally or imported.\n* `Local` - A local Intersight location.\n* `Uploaded` - A local location where the backup file is uploaded as mgmt.ConfigBackupFile MO. Intersight creates the backup from the uploaded location when this location type is set.\n* `Remote` - A remote location hosted in the user's datacenter.", "type": "string", "enum": [ "Local", "Uploaded", "Remote" ], "default": "Local", "x-omitempty": true }, "EndTime": { "description": "End date and time of the backup operation.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "IsAesKeySet": { "description": "Indicates whether the value of the 'aesKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsUserPasswordSet": { "description": "Indicates whether the value of the 'userPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Name": { "description": "User provided identifier for the backup operation.", "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "minLength": 3, "maxLength": 50, "x-omitempty": true }, "Options": { "description": "Options to control the behavior of the backup operation.", "$ref": "#/components/schemas/mgmt.BackupOptions", "x-omitempty": true }, "RetentionLock": { "description": "When set, ensures that the backup archive is protected from deletion and rollover operations. The value for retention lock is in sync with the backup instance created as part of this operation.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "RolloverInitiated": { "description": "Internal property used to indicate that a rollover has been initiated as part of this operation.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "Start date and time of the backup operation.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The current status of the backup operation.\n* `Scheduled` - Backup or restore process has been scheduled.\n* `NotInitiated` - Backup or restore process has not been initiated.\n* `InProgress` - Backup or restore process is in progress.\n* `Failed` - Backup or restore process has failed.\n* `Completed` - Backup or restore process has completed.\n* `NotComplete` - Backup or restore process has partially imported configuration.", "type": "string", "enum": [ "Scheduled", "NotInitiated", "InProgress", "Failed", "Completed", "NotComplete" ], "default": "Scheduled", "readOnly": true, "x-omitempty": true }, "SystemAdminTriggered": { "description": "Set when a system administrator initiated the backup operation.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "UserPassword": { "description": "The password provided by the user to decrypt a password encrypted backup file during import operation. \nThis password is used to decrypt the backup archive before validation when importing a password encrypted backup.\nThis field is optional and only required when importing a password encrypted backup file.", "type": "string", "pattern": "^$|^[a-zA-Z0-9=!&#$%+^@_*-]{8,127}$", "writeOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." }, "BackupInstance": { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance.Relationship", "description": "A reference to a mgmtConfigBackupInstance resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OrgBackups": { "description": "An array of relationships to mgmtOrgBackupOperation resources.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.OrgBackupOperation.Relationship" }, "nullable": true, "readOnly": true }, "UserBackupFile": { "$ref": "#/components/schemas/mgmt.ConfigBackupFile.Relationship", "description": "A reference to a mgmtConfigBackupFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "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.", "readOnly": true } } } ] }, "mgmt.ConfigBackupOperation.List": { "title": "List of 'mgmt.ConfigBackupOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.ConfigBackupOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.ConfigBackupOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation" }, "nullable": true } } } ] }, "mgmt.ConfigCategorySummary.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.ConfigCategorySummary' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.ConfigCategorySummary' resources.", "x-one-of-name": "mgmt.ConfigCategorySummary.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.ConfigCategorySummary.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.ConfigCategorySummary": { "title": "Mgmt:Config Category Summary", "description": "The ConfigCategorySummary object provides a categorized summary of what was captured in a backup instance. It is structured to help customers understand coverage and contents without inspecting raw backup archives.\n#### Purpose\nConfigCategorySummary exists to describe the backed-up configuration inventory in a structured way, grouped by scope (account vs organization) and by category (such as profiles, policies, templates, and similar groupings).\n#### Key Concepts\n- **Human-Readable Backup Inventory:** Offers an at-a-glance view of what the backup contains, improving transparency and operational confidence.\n- **Scope-Aware Categorization:** Separates account-owned and organization-owned configuration, reflecting how configuration is organized and governed.\n- **Category-Based Organization:** Groups items by meaningful configuration domains to support quick validation and reporting.\n- **Backup Instance Association:** Tightly bound to a specific backup artifact, ensuring summaries remain consistent with the exact backup content.", "x-allOf-name": "mgmt.ConfigCategorySummary", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigCategorySummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigCategorySummary" ], "default": "mgmt.ConfigCategorySummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigCategorySummary" ], "default": "mgmt.ConfigCategorySummary", "x-enum-as-string": true }, "CategoryName": { "description": "The name of the sub category. The objects are categorized based on the type of the object. For organization - it can be pools, policies, profiles, templates.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the organization or account.", "type": "string", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "The scope of the category, the objects belong to an organization or an account.", "type": "string", "readOnly": true, "x-omitempty": true }, "SummarySet": { "type": "array", "items": { "description": "Collection of objects backed up or restored.", "$ref": "#/components/schemas/mgmt.ConfigObjectDetails", "readOnly": true, "x-omitempty": true }, "nullable": true }, "BackupInstance": { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance.Relationship", "description": "A reference to a mgmtConfigBackupInstance resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "mgmt.ConfigCategorySummary.List": { "title": "List of 'mgmt.ConfigCategorySummary' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.ConfigCategorySummary' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.ConfigCategorySummary' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.ConfigCategorySummary" }, "nullable": true } } } ] }, "mgmt.ConfigObjectDetails": { "title": "Mgmt:Config Object Details", "description": "The details of the object backed up or restored.", "x-allOf-name": "mgmt.ConfigObjectDetails", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigObjectDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigObjectDetails" ], "default": "mgmt.ConfigObjectDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigObjectDetails" ], "default": "mgmt.ConfigObjectDetails", "x-enum-as-string": true }, "Description": { "description": "Description of object backed up or restored. Used to store organization and resource group decription.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the configured object.", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectMeta": { "description": "Additional information about the type of configured object.", "nullable": true, "readOnly": true, "x-omitempty": true }, "Type": { "description": "ObjectType of the configured object.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "mgmt.ConfigObjectRestoreDetails": { "title": "Mgmt:Config Object Restore Details", "description": "The details about the object restored.", "x-allOf-name": "mgmt.ConfigObjectRestoreDetails", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigObjectRestoreDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigObjectRestoreDetails" ], "default": "mgmt.ConfigObjectRestoreDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigObjectRestoreDetails" ], "default": "mgmt.ConfigObjectRestoreDetails", "x-enum-as-string": true }, "Description": { "description": "Description of the configured object.", "type": "string", "readOnly": true, "x-omitempty": true }, "ImportIsIncomplete": { "description": "Import couldn't complete due to version incompatibility and user has to fix the error manually.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IncompletionReason": { "description": "Reason for the incomplete import.", "type": "string", "readOnly": true, "x-omitempty": true }, "Message": { "description": "Additional info about the restore status.", "type": "string", "readOnly": true, "x-omitempty": true }, "Moid": { "description": "Moid of the configured object.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the configured object.", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectMeta": { "description": "Additional information about the type of configured object.", "nullable": true, "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the config object restore operation.\n* `Pending` - Indicates that the request is yet to be processed.\n* `ObjPresenceCheckInProgress` - Indicates that the checking for object presence is in progress.\n* `ObjPresenceCheckInComplete` - Indicates that the request is being processed.\n* `ObjPresenceCheckFailed` - Indicates that the checking for object presence failed.\n* `Processing` - Indicates that the request is being processed.\n* `TimedOut` - Indicates that the request processing timed out.\n* `Failed` - Indicates that the request processing failed.\n* `Completed` - Indicates that the request processing is complete.\n* `Partial` - Indicates that the request is partially complete due to an error.\n* `Skipped` - Indicates that the request was skipped.", "type": "string", "enum": [ "Pending", "ObjPresenceCheckInProgress", "ObjPresenceCheckInComplete", "ObjPresenceCheckFailed", "Processing", "TimedOut", "Failed", "Completed", "Partial", "Skipped" ], "default": "Pending", "readOnly": true, "x-omitempty": true }, "Type": { "description": "ObjectType of the configured object.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "mgmt.ConfigOperationSetting.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.ConfigOperationSetting' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.ConfigOperationSetting' resources.", "x-one-of-name": "mgmt.ConfigOperationSetting.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.ConfigOperationSetting.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.ConfigOperationSetting": { "title": "Mgmt:Config Operation Setting", "description": "The ConfigOperationSetting object represents account-level settings that support configuration backup and restore operations. It centralizes operational configuration required for consistent and secure handling of backup/restore flows.\n#### Purpose\nConfigOperationSetting exists to hold account-scoped operational settings used by the system to perform backup and restore reliably, including internal keying material required for secure processing.\n#### Key Concepts\n- **Account-Level Configuration:** Provides a single place to manage operational settings for all backup/restore activity within an account.\n- **Operational Consistency:** Ensures backup/restore executions behave predictably across runs by using consistent account-scoped settings.\n- **Governed Access:** Restricted to administrative roles to preserve integrity of backup and restore security posture.", "x-allOf-name": "mgmt.ConfigOperationSetting", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigOperationSetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigOperationSetting" ], "default": "mgmt.ConfigOperationSetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigOperationSetting" ], "default": "mgmt.ConfigOperationSetting", "x-enum-as-string": true }, "IsAccountKeySet": { "description": "Indicates whether the value of the 'accountKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." } } } ] }, "mgmt.ConfigOperationSetting.List": { "title": "List of 'mgmt.ConfigOperationSetting' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.ConfigOperationSetting' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.ConfigOperationSetting' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.ConfigOperationSetting" }, "nullable": true } } } ] }, "mgmt.ConfigRestoreCategorySummary.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.ConfigRestoreCategorySummary' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.ConfigRestoreCategorySummary' resources.", "x-one-of-name": "mgmt.ConfigRestoreCategorySummary.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.ConfigRestoreCategorySummary.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.ConfigRestoreCategorySummary": { "title": "Mgmt:Config Restore Category Summary", "description": "The ConfigRestoreCategorySummary object provides a categorized view of what is being restored (and what was restored) as part of a restore operation. It supports restore validation and reporting through structured summaries.\n#### Purpose\nConfigRestoreCategorySummary exists to summarize restore activity by scope and category, allowing customers to understand which configuration domains were targeted and their restored outcomes without relying on low-level import records.\n#### Key Concepts\n- **Restore Coverage Transparency:** Enables quick review of restore scope and category-level composition.\n- **Scope-Aware Reporting:** Reflects both account and organization configuration domains, aligning with how configuration ownership is structured.\n- **Category-Oriented Organization:** Groups restored items into meaningful operational categories to simplify validation by users and post-restore checks.\n- **Restore Operation Association:** Bound to a specific restore run, ensuring summaries correspond exactly to the initiated restore process.", "x-allOf-name": "mgmt.ConfigRestoreCategorySummary", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigRestoreCategorySummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigRestoreCategorySummary" ], "default": "mgmt.ConfigRestoreCategorySummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigRestoreCategorySummary" ], "default": "mgmt.ConfigRestoreCategorySummary", "x-enum-as-string": true }, "CategoryName": { "description": "The name of the sub category. The objects are categorized based on the type of the object. For organization - it can be pools, policies, profiles, templates.", "type": "string", "x-omitempty": true }, "Name": { "description": "The name of the organization or account.", "type": "string", "x-omitempty": true }, "Scope": { "description": "The scope of the category, the objects belong to an organization or an account.", "type": "string", "x-omitempty": true }, "SummarySet": { "type": "array", "items": { "description": "Collection of objects being restored.", "$ref": "#/components/schemas/mgmt.ConfigObjectRestoreDetails", "x-omitempty": true }, "nullable": true }, "RestoreOperation": { "$ref": "#/components/schemas/mgmt.ConfigRestoreOperation.Relationship", "description": "A reference to a mgmtConfigRestoreOperation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "mgmt.ConfigRestoreCategorySummary.List": { "title": "List of 'mgmt.ConfigRestoreCategorySummary' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.ConfigRestoreCategorySummary' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.ConfigRestoreCategorySummary' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.ConfigRestoreCategorySummary" }, "nullable": true } } } ] }, "mgmt.ConfigRestoreOperation.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.ConfigRestoreOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.ConfigRestoreOperation' resources.", "x-one-of-name": "mgmt.ConfigRestoreOperation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.ConfigRestoreOperation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.ConfigRestoreOperation.Relationship": { "description": "A relationship to the 'mgmt.ConfigRestoreOperation' resource, or the expanded 'mgmt.ConfigRestoreOperation' resource, or the 'null' value.", "x-one-of-name": "mgmt.ConfigRestoreOperation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/mgmt.ConfigRestoreOperation" } ], "discriminator": { "propertyName": "ClassId" } }, "mgmt.ConfigRestoreOperation": { "title": "Mgmt:Config Restore Operation", "description": "The ConfigRestoreOperation object represents an administrator-initiated configuration restore run. It tracks the end-to-end process of applying a previously captured backup to a target account, including progress, outcomes, and workflow coordination.\n#### Purpose\nConfigRestoreOperation exists to orchestrate restoration of configuration from a chosen backup source, providing a top-level record that drives restore execution, tracks status, and reports import progress across account and organization scopes.\n#### Key Concepts\n- **End-to-End Restore Orchestration:** Coordinates staging, importing, and completion of a restore run, enabling customers to manage restoration as a single operation.\n- **Source Flexibility:** Designed to support restoring from different backup locations (e.g., local repository), depending on operational needs.\n- **Controlled Restore Behavior:** Supports configurable restore strategies and error-handling behavior so customers can align restores with change-management requirements.\n- **Progress and Outcome Visibility:** Aggregates import status reporting so customers can monitor completion and detect partial or incomplete outcomes.\n- **Workflow Integration:** Links to underlying workflow execution details to support operational auditability and troubleshooting.", "x-allOf-name": "mgmt.ConfigRestoreOperation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ConfigRestoreOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ConfigRestoreOperation" ], "default": "mgmt.ConfigRestoreOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ConfigRestoreOperation" ], "default": "mgmt.ConfigRestoreOperation", "x-enum-as-string": true }, "AcctCategoryImportData": { "type": "array", "items": { "description": "The current status of account configuration import operations.", "$ref": "#/components/schemas/mgmt.CategoryImportData", "readOnly": true, "x-omitempty": true }, "nullable": true }, "BackupAccountMoid": { "description": "The moid of the account from which the backup was taken.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupName": { "description": "Name of the backup that needs to be restored.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupSource": { "description": "Indicates whether the backup was created locally or imported.\n* `Local` - A local Intersight location.\n* `Uploaded` - A local location where the backup file is uploaded as mgmt.ConfigBackupFile MO. Intersight creates the backup from the uploaded location when this location type is set.\n* `Remote` - A remote location hosted in the user's datacenter.", "type": "string", "enum": [ "Local", "Uploaded", "Remote" ], "default": "Local", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date and time of the restore process.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "IgnoreSecureProperties": { "description": "If set to true, secure properties will not be decrypted, and empty values will be used for these properties. As a result, if a secure property field is mandatory, the MO will be marked as incomplete.", "type": "boolean", "default": false, "x-omitempty": true }, "IsAesKeySet": { "description": "Indicates whether the value of the 'aesKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Name": { "description": "User provided identifier for the restore operation.", "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_-]*$", "minLength": 3, "maxLength": 50, "x-omitempty": true }, "Options": { "description": "Options to control the behavior of the restore operation.", "$ref": "#/components/schemas/mgmt.RestoreOptions", "x-omitempty": true }, "Source": { "description": "The type of source from which the backup - local or remote - needs to be restored.\n* `Local` - A local Intersight location.\n* `Uploaded` - A local location where the backup file is uploaded as mgmt.ConfigBackupFile MO. Intersight creates the backup from the uploaded location when this location type is set.\n* `Remote` - A remote location hosted in the user's datacenter.", "type": "string", "enum": [ "Local", "Uploaded", "Remote" ], "default": "Local", "x-omitempty": true }, "StartTime": { "description": "Start date and time of the restore process.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the restore operation.\n* `Scheduled` - Backup or restore process has been scheduled.\n* `NotInitiated` - Backup or restore process has not been initiated.\n* `InProgress` - Backup or restore process is in progress.\n* `Failed` - Backup or restore process has failed.\n* `Completed` - Backup or restore process has completed.\n* `NotComplete` - Backup or restore process has partially imported configuration.", "type": "string", "enum": [ "Scheduled", "NotInitiated", "InProgress", "Failed", "Completed", "NotComplete" ], "default": "Scheduled", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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." }, "AcctImportJobs": { "description": "An array of relationships to bulkRequest resources.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.Request.Relationship" }, "nullable": true, "readOnly": true }, "LocalSource": { "$ref": "#/components/schemas/mgmt.ConfigBackupInstance.Relationship", "description": "A reference to a mgmtConfigBackupInstance resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "OrgImportJobs": { "description": "An array of relationships to bulkRequest resources.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.Request.Relationship" }, "nullable": true, "readOnly": true }, "OrgRestores": { "description": "An array of relationships to mgmtOrgRestoreOperation resources.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.OrgRestoreOperation.Relationship" }, "nullable": true, "readOnly": true }, "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.", "readOnly": true } } } ] }, "mgmt.ConfigRestoreOperation.List": { "title": "List of 'mgmt.ConfigRestoreOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.ConfigRestoreOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.ConfigRestoreOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.ConfigRestoreOperation" }, "nullable": true } } } ] }, "mgmt.ObjectBackupMeta.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.ObjectBackupMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.ObjectBackupMeta' resources.", "x-one-of-name": "mgmt.ObjectBackupMeta.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.ObjectBackupMeta.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.ObjectBackupMeta": { "title": "Mgmt:Object Backup Meta", "description": "Meta data information used by the backup service to control the backup of MO types.", "x-allOf-name": "mgmt.ObjectBackupMeta", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.ObjectBackupMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.ObjectBackupMeta" ], "default": "mgmt.ObjectBackupMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.ObjectBackupMeta" ], "default": "mgmt.ObjectBackupMeta", "x-enum-as-string": true }, "ExcludeRelations": { "description": "No relations are to be exported, if specified.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ExcludedPeers": { "type": "array", "items": { "description": "The list of relations for which peer items should not be exported.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExportTimeout": { "description": "The time required in milli seconds to export one instance of this MO type with all its relations and values populated. The MO export timeout value is used to determine the timeout for the overall backup operation.", "type": "integer", "format": "int64", "default": 2000, "readOnly": true, "x-omitempty": true }, "Filter": { "description": "Odata filter to find matching instances that need to be backed up.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The MO type to be exported.", "type": "string", "readOnly": true, "x-omitempty": true }, "RelatedTypeOptions": { "type": "array", "items": { "description": "Export options for related item types.", "$ref": "#/components/schemas/bulk.RelatedTypeExportOption", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ReportingService": { "description": "The service that have reported this backup meta-data.", "type": "string", "readOnly": true, "x-omitempty": true }, "RestPath": { "description": "The rest path for the MO type.", "type": "string", "readOnly": true, "x-omitempty": true }, "Category": { "$ref": "#/components/schemas/mgmt.BackupCategory.Relationship", "description": "A reference to a mgmtBackupCategory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "mgmt.ObjectBackupMeta.List": { "title": "List of 'mgmt.ObjectBackupMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.ObjectBackupMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.ObjectBackupMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.ObjectBackupMeta" }, "nullable": true } } } ] }, "mgmt.OrgBackupOperation.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.OrgBackupOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.OrgBackupOperation' resources.", "x-one-of-name": "mgmt.OrgBackupOperation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.OrgBackupOperation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.OrgBackupOperation.Relationship": { "description": "A relationship to the 'mgmt.OrgBackupOperation' resource, or the expanded 'mgmt.OrgBackupOperation' resource, or the 'null' value.", "x-one-of-name": "mgmt.OrgBackupOperation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/mgmt.OrgBackupOperation" } ], "discriminator": { "propertyName": "ClassId" } }, "mgmt.OrgBackupOperation": { "title": "Mgmt:Org Backup Operation", "description": "The OrgBackupOperation object represents the organization-scoped portion of a broader configuration backup run. This provides visibility into how backup processing is applied per organization, while remaining governed by the parent backup operation.\n#### Purpose\nOrgBackupOperation exists to segment backup execution by organization so that organization-owned configuration can be handled, tracked, and reported exported independently within a single account-level backup.\n#### Key Concepts\n- **Per-Organization Backup Tracking:** Enables monitoring and reporting at the organization boundary, useful for environments with multiple orgs and delegated management.\n- **Inherited Governance:** Leverages the access controls and execution context of the parent backup operation to maintain consistent authorization and auditability.\n- **Category-Centric Reporting:** Organizes export activity by configuration categories to improve transparency of what was processed under an organization.\n- **Export Job Alignment:** Connects organization backups to the underlying export mechanisms used to produce the backup content.\nA subset of the config backup operation triggered by an admin user which creates configuration backups for an organization.", "x-allOf-name": "mgmt.OrgBackupOperation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.OrgBackupOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.OrgBackupOperation" ], "default": "mgmt.OrgBackupOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.OrgBackupOperation" ], "default": "mgmt.OrgBackupOperation", "x-enum-as-string": true }, "CategoryExportData": { "type": "array", "items": { "description": "Information regarding export jobs that are triggered for a category of objects inside the organization.", "$ref": "#/components/schemas/mgmt.CategoryExportData", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OrgName": { "description": "Name of the organization to be backed up.", "type": "string", "readOnly": true, "x-omitempty": true }, "PreserveIdentities": { "description": "The flag set by the user during a configuration backup to preserve static or dynamic IDs assigned to an export item.", "type": "boolean", "x-omitempty": true }, "Account": { "$ref": "#/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 }, "BackupOperation": { "$ref": "#/components/schemas/mgmt.ConfigBackupOperation.Relationship", "description": "A reference to a mgmtConfigBackupOperation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OrgExportJob": { "$ref": "#/components/schemas/bulk.Export.Relationship", "description": "A reference to a bulkExport resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "#/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.", "readOnly": true } } } ] }, "mgmt.OrgBackupOperation.List": { "title": "List of 'mgmt.OrgBackupOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.OrgBackupOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.OrgBackupOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.OrgBackupOperation" }, "nullable": true } } } ] }, "mgmt.OrgRestoreOperation.Response": { "description": "The response body of a HTTP GET request for the 'mgmt.OrgRestoreOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'mgmt.OrgRestoreOperation' resources.", "x-one-of-name": "mgmt.OrgRestoreOperation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/mgmt.OrgRestoreOperation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "mgmt.OrgRestoreOperation.Relationship": { "description": "A relationship to the 'mgmt.OrgRestoreOperation' resource, or the expanded 'mgmt.OrgRestoreOperation' resource, or the 'null' value.", "x-one-of-name": "mgmt.OrgRestoreOperation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/mgmt.OrgRestoreOperation" } ], "discriminator": { "propertyName": "ClassId" } }, "mgmt.OrgRestoreOperation": { "title": "Mgmt:Org Restore Operation", "description": "An organization-scoped portion of a configuration restore run with a dedicated view into how a restore is applied per organization, including sequencing and status.\n#### Purpose\nOrgRestoreOperation breaks down a restore operation into organization-level units so that organization-owned configuration can be processed and tracked independently while still being governed by the parent restore operation.\n#### Key Concepts\n- **Per-Organization Restore Tracking:** Enables fine-grained monitoring of restore progress and outcomes per organization.\n- **Sequenced Processing:** Supports deterministic ordering of organization restores to ensure dependencies and shared contexts organizations are handled predictably.\n- **Inherited Governance and Context:** Operates under the authorization and operational intent of the parent restore operation for consistency and auditability.\n- **Import Job Alignment:** Connects organization restore activity to the underlying import mechanisms used to apply configuration changes.", "x-allOf-name": "mgmt.OrgRestoreOperation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.OrgRestoreOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.OrgRestoreOperation" ], "default": "mgmt.OrgRestoreOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.OrgRestoreOperation" ], "default": "mgmt.OrgRestoreOperation", "x-enum-as-string": true }, "CategoryImportData": { "type": "array", "items": { "description": "The current status of configuration import operations for categories under the organization.", "$ref": "#/components/schemas/mgmt.CategoryImportData", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OrgName": { "description": "Name of the organization for which the restore operation is being performed.", "type": "string", "readOnly": true, "x-omitempty": true }, "SequenceNumber": { "description": "The sequence number that determines the order in which organization configurations will be processed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SharedOrgs": { "type": "array", "items": { "description": "List of organizations with which this organization is shared.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Status": { "description": "The current status of the restore operation.\n* `Scheduled` - Backup or restore process has been scheduled.\n* `NotInitiated` - Backup or restore process has not been initiated.\n* `InProgress` - Backup or restore process is in progress.\n* `Failed` - Backup or restore process has failed.\n* `Completed` - Backup or restore process has completed.\n* `NotComplete` - Backup or restore process has partially imported configuration.", "type": "string", "enum": [ "Scheduled", "NotInitiated", "InProgress", "Failed", "Completed", "NotComplete" ], "default": "Scheduled", "readOnly": true, "x-omitempty": true }, "ImportJobs": { "description": "An array of relationships to bulkRequest resources.", "type": "array", "items": { "$ref": "#/components/schemas/bulk.Request.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "#/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.", "readOnly": true }, "RestoreOperation": { "$ref": "#/components/schemas/mgmt.ConfigRestoreOperation.Relationship", "description": "A reference to a mgmtConfigRestoreOperation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "mgmt.OrgRestoreOperation.List": { "title": "List of 'mgmt.OrgRestoreOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'mgmt.OrgRestoreOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'mgmt.OrgRestoreOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/mgmt.OrgRestoreOperation" }, "nullable": true } } } ] }, "mgmt.RestoreOptions": { "title": "Mgmt:Restore Options", "description": "Options to control the behavior of a restore operation.", "x-allOf-name": "mgmt.RestoreOptions", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.RestoreOptions', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.RestoreOptions" ], "default": "mgmt.RestoreOptions", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.RestoreOptions" ], "default": "mgmt.RestoreOptions", "x-enum-as-string": true }, "ActionOnError": { "description": "The action to be taken if an error is encountered during the restore operation.\n* `Continue` - The restore operation will continue on encountering an error.Any failure will be tagged as incomplete and the operation will continue importing other configurations.User shall review the partially imported configuration and fix later.\n* `Stop` - The restore operation will stop on encountering an error.Configurations that were changed as part of the restore operation till the error was encountered will remain in the system.\n* `Rollback` - Configurations that were changed as part of the restore operation till the error was encountered will be rolled back.", "type": "string", "enum": [ "Continue", "Stop", "Rollback" ], "default": "Continue", "x-omitempty": true }, "OrgsToRestore": { "type": "array", "items": { "description": "List of names of organizations for which configurations need to be restored. If this is empty, configurations for all organizations will be restored.", "type": "string", "x-omitempty": true }, "nullable": true }, "RestoreAction": { "description": "Mechanism to be used for updating configurations as part of a restore operation.\n* `Merge` - Configurations in the backup will be merged with existing configurations in the target system.\n* `Replace` - Configurations in the target system will be replaced with the configurations in the backup.Configurations that are present only in the target system and not in the backup will be removed.", "type": "string", "enum": [ "Merge", "Replace" ], "default": "Merge", "x-omitempty": true } } } ] }, "mgmt.TypeWithFilter": { "title": "Mgmt:Type With Filter", "description": "Object type along with filter information.", "x-allOf-name": "mgmt.TypeWithFilter", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mgmt.TypeWithFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mgmt.TypeWithFilter" ], "default": "mgmt.TypeWithFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mgmt.TypeWithFilter" ], "default": "mgmt.TypeWithFilter", "x-enum-as-string": true }, "ChildTypes": { "type": "array", "items": { "description": "A list with information about types contained under this object type and processed during the backup operation of this type.", "$ref": "#/components/schemas/mgmt.ChildTypeInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Filter": { "description": "Filter used to obtain a list of objects of the given object type.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The type of the managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "RestPath": { "description": "The rest path for the MO type.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "mo.BaseComplexType": { "type": "object", "discriminator": { "propertyName": "ClassId" }, "title": "Mo:Base Complex Type", "description": "BaseComplexType is a base abstract class for all complex types. All complex types inherit from this base type.", "required": [ "ClassId", "ObjectType", "objectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.", "type": "string", "enum": [ "aaa.UserAgent", "access.AddressType", "access.ConfigurationType", "adapter.AdapterConfig", "adapter.DceInterfaceSettings", "adapter.EthSettings", "adapter.FcSettings", "adapter.PhysicalNicModeSettings", "adapter.PortChannelSettings", "apic.FabricLeafNodeDetails", "appliance.ApiStatus", "appliance.CertRenewalPhase", "appliance.ClusterInstallPhase", "appliance.KeyValuePair", "appliance.MetadataManifestVersion", "appliance.NetworkStatus", "appliance.NodeIpInfo", "appliance.StatusCheck", "asset.AddressInformation", "asset.AlarmSummary", "asset.ApiKeyCredential", "asset.ClientCertificateCredential", "asset.CloudConnection", "asset.ConnectionFlapStatus", "asset.ContractInformation", "asset.CustomerInformation", "asset.DeploymentAlarmInfo", "asset.DeploymentDeviceAlarmInfo", "asset.DeploymentDeviceInformation", "asset.DeviceEndpointLocalCredential", "asset.DeviceInformation", "asset.DeviceStatistics", "asset.DeviceTransaction", "asset.GenericTargetClaimOptions", "asset.GlobalUltimate", "asset.GoogleCloudPlatformServiceAccountKeyCredential", "asset.HttpConnection", "asset.IntersightDeviceConnectorConnection", "asset.MerakiCloudOptions", "asset.MeteringType", "asset.NewRelicCredential", "asset.NoAuthenticationCredential", "asset.OauthBearerTokenCredential", "asset.OauthClientIdSecretCredential", "asset.OrchestrationCivpVmwareVcenterOptions", "asset.OrchestrationHitachiVirtualStoragePlatformOptions", "asset.OrchestrationHsmVmwareVcenterOptions", "asset.OrchestrationService", "asset.ParentConnectionSignature", "asset.PrivateKeyCredential", "asset.ProductInformation", "asset.ScopedTargetConnection", "asset.ServiceNowCredential", "asset.SplunkTokenCredential", "asset.SshConnection", "asset.SudiInfo", "asset.TargetKey", "asset.TargetSignature", "asset.TargetStatusDetails", "asset.TerraformIntegrationService", "asset.TerraformIntegrationTerraformAgentOptions", "asset.TerraformIntegrationTerraformCloudOptions", "asset.Token", "asset.UsernamePasswordCredential", "asset.VirtualizationAmazonWebServiceOptions", "asset.VirtualizationService", "asset.VmHost", "asset.WorkloadOptimizerAmazonWebServicesBillingOptions", "asset.WorkloadOptimizerDynatraceOptions", "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions", "asset.WorkloadOptimizerHypervOptions", "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions", "asset.WorkloadOptimizerMicrosoftAzureBillingOptions", "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions", "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions", "asset.WorkloadOptimizerMicrosoftSqlServerOptions", "asset.WorkloadOptimizerNewRelicOptions", "asset.WorkloadOptimizerOpenStackOptions", "asset.WorkloadOptimizerOracleDatabaseServerOptions", "asset.WorkloadOptimizerRedHatOpenStackOptions", "asset.WorkloadOptimizerService", "asset.WorkloadOptimizerVmwareVcenterOptions", "auditd.LogMonitorType", "bios.C845ServerBiosConfiguration", "bios.CbsCmnApbdisC845BiosToken", "bios.CbsCmnCpuAvx512C845BiosToken", "bios.CbsCmnCpuCpbC845BiosToken", "bios.CbsCmnCpuDowncoreModeC845BiosToken", "bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken", "bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken", "bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken", "bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken", "bios.CbsCmnCpuSmeeC845BiosToken", "bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken", "bios.CbsCmnCxlMemOnlineOfflineC845BiosToken", "bios.CbsCmnDeterminismCtlC845BiosToken", "bios.CbsCmnDeterminismEnableC845BiosToken", "bios.CbsCmnGnbNbIommuC845BiosToken", "bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken", "bios.CbsCmnMemCsInterleaveDdrC845BiosToken", "bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken", "bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken", "bios.CbsCmnMemDramRefreshRateC845BiosToken", "bios.CbsCmnMemDramScrubTimeC845BiosToken", "bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken", "bios.CbsCmnMemHealingBistExecutionModeC845BiosToken", "bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken", "bios.CbsCmnMemTsmeEnableDdrC845BiosToken", "bios.CbsCmnPcieCaplinkSpeedC845BiosToken", "bios.CbsCpuCcdCtrlC845BiosToken", "bios.CbsCpuSmtCtrlC845BiosToken", "bios.CbsDbgCpuLapicModeC845BiosToken", "bios.CbsDbgCpuSnpMemCoverC845BiosToken", "bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken", "bios.CbsDfCmnAcpiSratL3NumaC845BiosToken", "bios.CbsDfCmnDramNpsC845BiosToken", "bios.CbsSevSnpSupportC845BiosToken", "bios.Cpu005C845BiosToken", "bios.Ipmi100C845BiosToken", "bios.Ipmi103C845BiosToken", "bios.Ipmi104C845BiosToken", "bios.Ipmi105C845BiosToken", "bios.Nvlck002C845BiosToken", "bios.Nwsk001C845BiosToken", "bios.Nwsk002C845BiosToken", "bios.Nwsk006C845BiosToken", "bios.Nwsk007C845BiosToken", "bios.Pcid001C845BiosToken", "bios.Pcid002C845BiosToken", "bios.Pcid003C845BiosToken", "bios.Ptt000C845BiosToken", "bios.Tcg001C845BiosToken", "bios.Tcg003C845BiosToken", "bios.Tcg007C845BiosToken", "bios.Tcg018C845BiosToken", "bios.Tcg019C845BiosToken", "bios.Ter001C845BiosToken", "bios.Ter0021C845BiosToken", "bios.Ter012C845BiosToken", "bios.Ter05dC845BiosToken", "blueprint.BlueprintDefinitionDependency", "blueprint.GeneratedObjectMetadata", "blueprint.GeneratedObjectNew", "blueprint.GeneratedObjectOperationTarget", "blueprint.GeneratedObjectSourceClone", "blueprint.GeneratedObjectSourceLookup", "blueprint.GeneratedObjectSourceMerge", "blueprint.GeneratedObjectSourceReference", "blueprint.GeneratedObjectSourceSelector", "blueprint.InputOperationType", "blueprint.PreGenerateOperation", "blueprint.PropertyIteration", "blueprint.ResourceConstraints", "blueprint.ServiceItemDefinition", "boot.Bootloader", "boot.FlexMmc", "boot.Http", "boot.Iscsi", "boot.LocalCdd", "boot.LocalDisk", "boot.Nvme", "boot.PchStorage", "boot.Pxe", "boot.San", "boot.SdCard", "boot.StaticIpV4Settings", "boot.StaticIpV6Settings", "boot.UefiShell", "boot.Usb", "boot.VirtualMedia", "bulk.HttpHeader", "bulk.MultiRelationEntryPatch", "bulk.PatchContent", "bulk.RelatedTypeExportOption", "bulk.RestResult", "bulk.RestSubRequest", "bulk.SecResourceRoles", "bulk.SubRequestsGroup", "capability.AdapterConnectionPoint", "capability.CertificatePropertyConstraints", "capability.DeviceInventory", "capability.FeatureConfig", "capability.GpuConnectionPoint", "capability.HsuIsoModelSpecificConstraint", "capability.LdapBasePropertyConstraints", "capability.PcIdRange", "capability.PortPropertyConstraints", "capability.PortRange", "capability.ServerComponentConstraint", "capability.ServerPcieConnectivityLayout", "capability.ServerPcieTopology", "capability.SwitchControlPolicyConstraints", "capability.SwitchNetworkLimits", "capability.SwitchStorageLimits", "capability.SwitchSystemLimits", "capability.SwitchingModeCapability", "capability.UnsupportedFeatureConfig", "capability.UpdateOrderListType", "certificatemanagement.Imc", "certificatemanagement.RootCaCertificate", "chassis.ChassisAssignment", "cloud.TfcWorkspaceVariables", "cmrf.CmRf", "comm.GeoLocationDetails", "comm.GeoPoint", "comm.IpV4AddressBlock", "comm.IpV4Interface", "comm.IpV6Interface", "comm.PhysicalAddress", "comm.TagUsage", "compute.AdapterUnitConfig", "compute.AdapterUnitPropFilter", "compute.AlarmSummary", "compute.CpuConfig", "compute.GpuConfig", "compute.GpuPropFilter", "compute.IpAddress", "compute.MigrationKeyInfo", "compute.PcieZone", "compute.PendingWorkflowTrigger", "compute.PersistentMemoryModule", "compute.PersistentMemoryOperation", "compute.PersonalitySetting", "compute.RecoveryKeyDetails", "compute.ScrubOpConfigutation", "compute.ServerConfig", "compute.ServerOpStatus", "compute.StorageControllerOperation", "compute.StoragePhysicalDrive", "compute.StoragePhysicalDriveOperation", "compute.StorageUtilityImageOperation", "compute.StorageVirtualDrive", "compute.StorageVirtualDriveOperation", "cond.AdapterBaselineStatus", "cond.AdapterDetail", "cond.AdapterInstance", "cond.AlarmAction", "cond.AlarmClassificationEligibility", "cond.AlarmPreview", "cond.AlarmRuleExpression", "cond.AlarmSpec", "cond.AlarmSummary", "cond.AlarmSuppressionDryRunSummary", "cond.FilterRule", "cond.ServerBaselineStatus", "connector.CloseStreamMessage", "connector.CommandControlMessage", "connector.CommandTerminalStream", "connector.EventLog", "connector.ExpectPrompt", "connector.FetchStreamMessage", "connector.FileChecksum", "connector.FileMessage", "connector.HttpRequest", "connector.SshConfig", "connector.SshMessage", "connector.StartStream", "connector.StartStreamFromDevice", "connector.StreamAcknowledge", "connector.StreamInput", "connector.StreamKeepalive", "connector.TargetChangeMessage", "connector.TargetSpecification", "connector.Url", "connector.WinrmRequest", "connector.XmlApiMessage", "connectorpack.ConnectorPackUpdate", "content.ComplexType", "content.Parameter", "content.TextParameter", "convergedinfra.AlarmSummary", "convergedinfra.ComplianceSummary", "convergedinfra.PodSummary", "crd.CustomResourceConfigProperty", "equipment.ChassisOperationStatus", "equipment.ChassisOperationsDetails", "equipment.DeviceLocation", "equipment.IoCardIdentity", "equipment.IoCardOperationStatus", "equipment.PendingWorkflowTrigger", "equipment.ResetAction", "ether.MacsecOperData", "fabric.ChassisAssignment", "fabric.ClusterAssignment", "fabric.FcZoneMember", "fabric.FlowNonKey", "fabric.Ipv4FlowKey", "fabric.Ipv6FlowKey", "fabric.L2FlowKey", "fabric.LldpGlobalSettings", "fabric.LldpSettings", "fabric.MacAgingSettings", "fabric.MacLearningSettings", "fabric.MacSecEaPol", "fabric.PfcWatchDog", "fabric.PortIdentifier", "fabric.QosClass", "fabric.SecKey", "fabric.SecKeyChain", "fabric.StpGlobalSettings", "fabric.SwitchAssignment", "fabric.UdldGlobalSettings", "fabric.UdldSettings", "fabric.VlanExportInterface", "fabric.VlanSettings", "fcpool.Block", "fcpool.ReservationReference", "feedback.FeedbackData", "filterexpr.AndFilterExpression", "filterexpr.OrFilterExpression", "filterexpr.PredicateFilterExpression", "firmware.ChassisUpgradeImpact", "firmware.CifsServer", "firmware.ComponentImpact", "firmware.ComponentMeta", "firmware.DirectDownload", "firmware.ExcludeComponentPidListType", "firmware.FabricUpgradeImpact", "firmware.FeatureVersionMap", "firmware.FirmwareInventory", "firmware.HttpServer", "firmware.ModelBundleVersion", "firmware.NetworkShare", "firmware.NfsServer", "firmware.ServerImpact", "firmware.ServerUpgradeImpact", "firmware.VersionMap", "forecast.Model", "hci.AhvGuestTools", "hci.AlarmParameter", "hci.AlarmSummary", "hci.ApiLimit", "hci.BackplaneNetworkParams", "hci.CapacityViolation", "hci.ClusterOpInfo", "hci.ConfigurableParamValue", "hci.ConfigurableParamValueRange", "hci.Consumption", "hci.EntitlementDetail", "hci.EsxiGuestTools", "hci.ExpiredLicense", "hci.ExternalStorageArray", "hci.FaultToleranceState", "hci.FeatureViolation", "hci.IpAddress", "hci.IpAddressOrFqdn", "hci.KeyManagementDeviceToCertStatusInfo", "hci.LicensedService", "hci.ManagementServer", "hci.NccConfigurableParameter", "hci.NutanixClusterCheck", "hci.PendingWorkflowTrigger", "hci.PulseStatus", "hci.Sbdf", "hci.SdaPolicyClusterConfig", "hci.ServiceViolation", "hci.SoftwareType", "hci.VirtualGpuConfig", "hcl.Constraint", "hcl.Firmware", "hcl.HardwareCompatibilityProfile", "hcl.Product", "hcl.ServerConfiguration", "hyperflex.AlarmSummary", "hyperflex.AppSettingConstraint", "hyperflex.BackupPolicySettings", "hyperflex.Capability", "hyperflex.DatastoreInfo", "hyperflex.EntityReference", "hyperflex.ErrorStack", "hyperflex.FeatureLimitEntry", "hyperflex.FilePath", "hyperflex.HealthCheckNodeLevelInfo", "hyperflex.HealthCheckScriptInfo", "hyperflex.HxHostMountStatusDt", "hyperflex.HxLicenseAuthorizationDetailsDt", "hyperflex.HxLinkDt", "hyperflex.HxNetworkAddressDt", "hyperflex.HxPlatformDatastoreConfigDt", "hyperflex.HxRegistrationDetailsDt", "hyperflex.HxResiliencyInfoDt", "hyperflex.HxSiteDt", "hyperflex.HxUuIdDt", "hyperflex.HxZoneInfoDt", "hyperflex.HxZoneResiliencyInfoDt", "hyperflex.IpAddrRange", "hyperflex.LogicalAvailabilityZone", "hyperflex.MacAddrPrefixRange", "hyperflex.MapClusterIdToProtectionInfo", "hyperflex.MapClusterIdToStSnapshotPoint", "hyperflex.MapUuidToTrackedDisk", "hyperflex.NamedVlan", "hyperflex.NamedVsan", "hyperflex.NetworkConfiguration", "hyperflex.PortTypeToPortNumberMap", "hyperflex.ProtectionInfo", "hyperflex.ReSyncClusterMoIds", "hyperflex.ReplicationClusterReferenceToSchedule", "hyperflex.ReplicationPeerInfo", "hyperflex.ReplicationPlatDatastore", "hyperflex.ReplicationPlatDatastorePair", "hyperflex.ReplicationSchedule", "hyperflex.ReplicationStatus", "hyperflex.RpoStatus", "hyperflex.ServerFirmwareVersionInfo", "hyperflex.ServerModelEntry", "hyperflex.SiteDetails", "hyperflex.SnapshotFiles", "hyperflex.SnapshotInfoBrief", "hyperflex.SnapshotPoint", "hyperflex.SnapshotStatus", "hyperflex.StPlatformClusterHealingInfo", "hyperflex.StPlatformClusterResiliencyInfo", "hyperflex.Summary", "hyperflex.TrackedDisk", "hyperflex.TrackedFile", "hyperflex.VcenterConfiguration", "hyperflex.VirtualMachine", "hyperflex.VirtualMachineRuntimeInfo", "hyperflex.VmProtectionSpaceUsage", "hyperflex.WwxnPrefixRange", "i18n.Message", "i18n.MessageParam", "iaas.LicenseKeysInfo", "iaas.LicenseUtilizationInfo", "iaas.WorkflowSteps", "iam.AccountPermissions", "iam.AccountTags", "iam.AccountTypeIpmi", "iam.AccountTypeLocal", "iam.BasicAuthCredentials", "iam.ClientMeta", "iam.DefaultPermissionInfo", "iam.EncryptedOidcAuthTokenSet", "iam.EndPointPasswordProperties", "iam.FailureDetails", "iam.FeatureDefinition", "iam.GroupPermissionToRoles", "iam.LdapBaseProperties", "iam.LdapDnsParameters", "iam.OidcAuthTokenSet", "iam.PasswordHistorySetting", "iam.PermissionReference", "iam.PermissionToRoles", "iam.ResourceRole", "iam.Rule", "iam.SamlSpConnection", "iam.SecurityContext", "iam.SsoSessionAttributes", "iam.SwitchAccountPermission", "iam.SwitchScopePermissions", "iam.TenantLinking", "iam.UserDetails", "imcconnector.WebUiMessage", "infra.GpuConfiguration", "infra.HardwareInfo", "infra.MetaData", "infra.MigGpuConfiguration", "inventory.InventoryMo", "inventory.JobInfo", "inventory.UemInfo", "ippool.IpV4Block", "ippool.IpV4Config", "ippool.IpV6Block", "ippool.IpV6Config", "ippool.ReservationReference", "iqnpool.IqnSuffixBlock", "iqnpool.ReservationReference", "issue.DeviceTag", "issue.Message", "issue.OdataCondition", "license.SubstituteLicense", "macpool.Block", "macpool.MemberOf", "macpool.ReservationReference", "management.ReplayConfigInfo", "memory.PersistentMemoryGoal", "memory.PersistentMemoryLocalSecurity", "memory.PersistentMemoryLogicalNamespace", "meta.AccessPrivilege", "meta.DisplayNameDefinition", "meta.IdentityDefinition", "meta.PropDefinition", "meta.RelationshipDefinition", "metric.SeverityCriteria", "metric.ThresholdCondition", "metric.ThresholdDefinitionState", "metrics.MetricCriterion", "mgmt.BackupOptions", "mgmt.CategoryExportData", "mgmt.CategoryImportData", "mgmt.ChildTypeInfo", "mgmt.ConfigObjectDetails", "mgmt.ConfigObjectRestoreDetails", "mgmt.RestoreOptions", "mgmt.TypeWithFilter", "mo.MoRef", "mo.Tag", "mo.VersionContext", "monitoring.CategoryStatus", "motemplate.ActionEntry", "motemplate.ActionParam", "motemplate.SyncError", "network.HyperFlexInternetProtocolAddressRange", "network.HyperFlexNetworkAddress", "network.SecureRouterInfo", "niaapi.Detail", "niaapi.NewReleaseDetail", "niaapi.RevisionInfo", "niaapi.SoftwareRegex", "niaapi.VersionRegexPlatform", "niatelemetry.Advisories", "niatelemetry.BootflashDetails", "niatelemetry.CloudRegionsElement", "niatelemetry.CloudRoutersElement", "niatelemetry.DeploymentStatus", "niatelemetry.DigitalOpticalMonitoring", "niatelemetry.Diskinfo", "niatelemetry.DomInfo", "niatelemetry.DomThresInfo", "niatelemetry.EqptStorageFirmware", "niatelemetry.EqptcapacityPolUsage5min", "niatelemetry.EqptcapacityPrefixEntries15min", "niatelemetry.EqptcapacityPrefixEntries5min", "niatelemetry.FanDetails", "niatelemetry.ImageDetail", "niatelemetry.Interface", "niatelemetry.InterfaceElement", "niatelemetry.JobDetail", "niatelemetry.LogicalLink", "niatelemetry.MdsNeighborInfo", "niatelemetry.NetworkInfo", "niatelemetry.Node", "niatelemetry.NvePacketCounters", "niatelemetry.NveVni", "niatelemetry.NxosBgpEvpn", "niatelemetry.NxosBgpMvpn", "niatelemetry.NxosModuleInfo", "niatelemetry.NxosVtp", "niatelemetry.ProcSysCpu15min", "niatelemetry.ProcSysCpu5min", "niatelemetry.ProcSysMem15min", "niatelemetry.ProcSysMem5min", "niatelemetry.RouteNextHop", "niatelemetry.Sites", "niatelemetry.SmartLicense", "niatelemetry.SwitchDiskUtilization", "niatelemetry.VniStatus", "niatelemetry.VpcDetails", "notification.AdvisoryMoCondition", "notification.AggregationSettings", "notification.AlarmMoCondition", "notification.ApplianceUpgradeMoCondition", "notification.DistributableMoCondition", "notification.EolAdvisoryFilter", "notification.FieldNoticeAdvisoryFilter", "notification.HttpHeader", "notification.MoCondition", "notification.SecurityAdvisoryFilter", "notification.SendEmail", "notification.SimpleFilter", "notification.SimpleMoCondition", "notification.SoftwareReleaseMetaMoCondition", "notification.TriggerWebhook", "ntp.AuthNtpServer", "onprem.ClusterInfo", "onprem.ClusterNode", "onprem.ImagePackage", "onprem.ResourceInfo", "onprem.Schedule", "onprem.UpgradeNote", "onprem.UpgradePhase", "openapi.ApiInfo", "openapi.FailedTask", "openapi.KeyValuePair", "oprs.Kvpair", "os.Answers", "os.FibreChannelResponse", "os.FibreChannelTarget", "os.GlobalConfig", "os.Ipv4Configuration", "os.Ipv6Configuration", "os.IscsiLunResponse", "os.IscsiTarget", "os.PhysicalDisk", "os.PhysicalDiskResponse", "os.PlaceHolder", "os.ServerConfig", "os.ValidationInformation", "os.VirtualDrive", "os.VirtualDriveResponse", "os.VmwareParameters", "os.WindowsParameters", "partnerintegration.MetricsModel", "pkix.DistinguishedName", "pkix.EcdsaKeySpec", "pkix.EddsaKeySpec", "pkix.RsaAlgorithm", "pkix.SubjectAlternateName", "policy.ActionParam", "policy.ActionQualifier", "policy.ConfigChange", "policy.ConfigChangeContext", "policy.ConfigChangeDetailType", "policy.ConfigChangeDisruptionDetailType", "policy.ConfigContext", "policy.ConfigResultContext", "policy.PolicyContextHolder", "policy.PolicyError", "policy.PolicyStatus", "policy.Qualifier", "policy.ReportedPolicyChange", "policy.ScheduledAction", "recovery.BackupSchedule", "resource.AdaptorsRangeFilter", "resource.BladeQualifier", "resource.ChassisAndSlotQualification", "resource.ChassisIdRangeFilter", "resource.ChassisServersQualifier", "resource.CpuCoreRangeFilter", "resource.CpuSpeedRangeFilter", "resource.DomainQualifier", "resource.GpuControllersRangeFilter", "resource.GpuQualifier", "resource.MemoryCapacityRangeFilter", "resource.MemoryQualifier", "resource.MemoryUnitsRangeFilter", "resource.NetworkAdaptorQualifier", "resource.OdataRuleSetQualifier", "resource.PerTypeCombinedSelector", "resource.ProcessorQualifier", "resource.RackIdRangeFilter", "resource.RackServerQualifier", "resource.Selector", "resource.SlotIdRangeFilter", "resource.SourceToPermissionResources", "resource.SourceToPermissionResourcesHolder", "resource.Tag", "resource.TagQualifier", "resourcepool.ChildLeaseCondition", "resourcepool.QualificationType", "resourcepool.ReservationReference", "resourcepool.ResourceEvaluationStatus", "resourcepool.ServerLeaseParameters", "resourcepool.ServerPoolParameters", "scheduler.BlockDate", "scheduler.DailyCadenceParams", "scheduler.EveryCadenceParams", "scheduler.MonthlyCadenceParams", "scheduler.OneTimeScheduleParams", "scheduler.RecurringScheduleParams", "scheduler.RestStimTaskRequest", "scheduler.TaskResultStatus", "scheduler.TaskSchedulePolicyExecutionStatus", "scheduler.TaskScheduleStatus", "scheduler.WeeklyCadenceParams", "sdcard.Diagnostics", "sdcard.Drivers", "sdcard.HostUpgradeUtility", "sdcard.OperatingSystem", "sdcard.Partition", "sdcard.ServerConfigurationUtility", "sdcard.UserPartition", "server.DiagnosticResult", "server.PendingWorkflowTrigger", "server.ServerAssignTypeSlot", "server.ServerAssignment", "serviceitem.HealthCheckErrorElement", "serviceitem.Message", "serviceitem.SelectionCriteriaInput", "servicerequest.Message", "snmp.Trap", "snmp.User", "softwarerepository.ApplianceUpload", "softwarerepository.CifsServer", "softwarerepository.ConstraintModels", "softwarerepository.HttpServer", "softwarerepository.ImportResult", "softwarerepository.LocalMachine", "softwarerepository.NfsServer", "softwarerepository.UnsupportedModelConstraint", "storage.AutomaticDriveGroup", "storage.ExternalLun", "storage.ExternalParityGroup", "storage.ExternalPath", "storage.HitachiArrayUtilization", "storage.HitachiCapacity", "storage.HitachiInitiator", "storage.HostNqn", "storage.HyperFlexIscsiInitiator", "storage.Initiator", "storage.InternalMoPhysicalDiskConfig", "storage.KeySetting", "storage.KmipAuthCredentials", "storage.KmipServer", "storage.LocalKeySetting", "storage.M2VirtualDriveConfig", "storage.ManualDriveGroup", "storage.Namespace", "storage.NamespacePath", "storage.NetAppAutoSupport", "storage.NetAppCifsAcl", "storage.NetAppEthernetPortLag", "storage.NetAppEthernetPortVlan", "storage.NetAppExportPolicyRule", "storage.NetAppHighAvailability", "storage.NetAppPerformanceMetricsAverage", "storage.NetAppPort", "storage.NetAppSnapshotPolicySchedule", "storage.NetAppStorageClusterEfficiency", "storage.NetAppStorageUtilization", "storage.NvmeDedicatedHotSpareConfiguration", "storage.NvmePhysicalDiskState", "storage.NvmeRaidDriveGroup", "storage.NvmeVirtualDriveConfiguration", "storage.PureArrayUtilization", "storage.PureDiskUtilization", "storage.PureFlashBladeUtilization", "storage.PureHostUtilization", "storage.PurePodUtilization", "storage.PureRealmUtilization", "storage.PureReplicationBlackout", "storage.PureVolumeUtilization", "storage.R0Drive", "storage.RemoteKeySetting", "storage.Space", "storage.SpanDrives", "storage.StorageContainerHostMountStatus", "storage.StorageContainerUtilization", "storage.VirtualDriveConfiguration", "storage.VirtualDrivePolicy", "storage.VolumeUtilization", "syslog.LocalFileLoggingClient", "syslog.RemoteLoggingClient", "tam.Action", "tam.ApiDataSource", "tam.EolAdvisoryDetails", "tam.EolSeverity", "tam.FnSeverity", "tam.Identifiers", "tam.Milestone", "tam.PsirtSeverity", "tam.QueryEntry", "tam.S3DataSource", "tam.SecurityAdvisoryDetails", "tam.TextFsmTemplateDataSource", "techsupportmanagement.ApplianceParam", "techsupportmanagement.NiaParam", "techsupportmanagement.PlatformParam", "techsupportmanagement.TechSupportFileInfo", "template.TransformationStage", "ucsd.ConnectorPack", "ucsd.UcsdRestoreParameters", "ucsdconnector.RestClientMessage", "uuidpool.ReservationReference", "uuidpool.UuidBlock", "virtualization.ActionInfo", "virtualization.CloudInitConfig", "virtualization.ComputeCapacity", "virtualization.CpuInfo", "virtualization.EsxiCloneCustomSpec", "virtualization.EsxiHostConfiguration", "virtualization.EsxiOvaCustomSpec", "virtualization.EsxiVmComputeConfiguration", "virtualization.EsxiVmConfiguration", "virtualization.EsxiVmNetworkConfiguration", "virtualization.EsxiVmStorageConfiguration", "virtualization.GuestInfo", "virtualization.MemoryCapacity", "virtualization.NetworkInterface", "virtualization.ProductInfo", "virtualization.StorageCapacity", "virtualization.VirtualMachineDisk", "virtualization.VmEsxiDisk", "virtualization.VmwareAttachedResourceTag", "virtualization.VmwareDiscoveryProtocol", "virtualization.VmwareRemoteDisplayInfo", "virtualization.VmwareResourceAllocationSystemTrafficTypes", "virtualization.VmwareResourceConsumption", "virtualization.VmwareSharesInfo", "virtualization.VmwareTeamingAndFailover", "virtualization.VmwareVlanRange", "virtualization.VmwareVmCpuShareInfo", "virtualization.VmwareVmCpuSocketInfo", "virtualization.VmwareVmDiskCommitInfo", "virtualization.VmwareVmMemoryShareInfo", "vmedia.Mapping", "vnic.ArfsSettings", "vnic.Cdn", "vnic.CompletionQueueSettings", "vnic.EthIfOldInfo", "vnic.EthInterruptSettings", "vnic.EthRxQueueSettings", "vnic.EthTxQueueSettings", "vnic.FcErrorRecoverySettings", "vnic.FcIfOldInfo", "vnic.FcInterruptSettings", "vnic.FcQueueSettings", "vnic.FlogiSettings", "vnic.IscsiAuthProfile", "vnic.Lun", "vnic.NetFlowMonitorSession", "vnic.NvgreSettings", "vnic.PlacementSettings", "vnic.PlogiSettings", "vnic.PtpSettings", "vnic.RoceSettings", "vnic.RssHashSettings", "vnic.SanSettingsOldInfo", "vnic.ScsiQueueSettings", "vnic.SriovSettings", "vnic.TcpOffloadSettings", "vnic.UsnicSettings", "vnic.VifStatus", "vnic.VlanSettings", "vnic.VmqSettings", "vnic.VsanSettings", "vnic.VxlanSettings", "workflow.AnsiblePlaySession", "workflow.ArrayDataType", "workflow.AssociatedRoles", "workflow.CancelableType", "workflow.CliCommand", "workflow.Comments", "workflow.Constraints", "workflow.CustomArrayItem", "workflow.CustomDataProperty", "workflow.CustomDataType", "workflow.CustomDataTypeProperties", "workflow.DataSourceSelector", "workflow.DecisionCase", "workflow.DecisionTask", "workflow.DefaultValue", "workflow.DisplayMeta", "workflow.DynamicTemplateParserDataType", "workflow.EnumEntry", "workflow.EnvironmentVariableReference", "workflow.ExpectPrompt", "workflow.FailureEndTask", "workflow.FileDownloadOp", "workflow.FileOperations", "workflow.FileTemplateOp", "workflow.FileTransfer", "workflow.ForkTask", "workflow.InitiatorContext", "workflow.InternalProperties", "workflow.JoinTask", "workflow.LoopTask", "workflow.Message", "workflow.MigrateServiceItemActionProperty", "workflow.MigrationHistory", "workflow.MoInventoryDataType", "workflow.MoInventoryProperty", "workflow.MoReferenceArrayItem", "workflow.MoReferenceAutoArrayItem", "workflow.MoReferenceAutoDataType", "workflow.MoReferenceAutoProperty", "workflow.MoReferenceDataType", "workflow.MoReferenceForCloneDataType", "workflow.MoReferenceProperty", "workflow.OperationTypeDecommission", "workflow.OperationTypeDeployment", "workflow.OperationTypePostDeployment", "workflow.ParameterSet", "workflow.PowerShellApi", "workflow.PrimitiveArrayItem", "workflow.PrimitiveDataProperty", "workflow.PrimitiveDataType", "workflow.Properties", "workflow.ResourceInlineSelector", "workflow.ResourceSelectorCriteria", "workflow.ResultHandler", "workflow.RollbackTask", "workflow.RollbackWorkflowTask", "workflow.SelectorProperty", "workflow.SequenceParams", "workflow.SerialLoopTask", "workflow.ServiceItemActionProperties", "workflow.ServiceItemActionWorkflowDefinition", "workflow.ServiceItemInputDefinitionType", "workflow.ServiceItemType", "workflow.SshCmd", "workflow.SshConfig", "workflow.SshSession", "workflow.StartTask", "workflow.SubWorkflowTask", "workflow.SuccessEndTask", "workflow.TargetContext", "workflow.TargetDataType", "workflow.TargetProperty", "workflow.TaskConstraints", "workflow.TaskInfoUpdate", "workflow.TaskLoopInfo", "workflow.TaskRetryInfo", "workflow.UiFormConfig", "workflow.UiInputFilter", "workflow.UiViewConfig", "workflow.ValidationError", "workflow.ValidationInformation", "workflow.WaitTask", "workflow.WaitTaskPrompt", "workflow.WebApi", "workflow.WorkerTask", "workflow.WorkflowCtx", "workflow.WorkflowEngineProperties", "workflow.WorkflowInfoAutoRestartProperties", "workflow.WorkflowInfoProperties", "workflow.WorkflowProperties", "workflow.XmlApi", "workload.AssignedResource", "workload.BatchDeployment", "workload.BlueprintInputReference", "workload.BlueprintReference", "workload.CanaryDeployment", "workload.CloneStatus", "workload.CloneStatusEntry", "workload.DefinitionMapper", "workload.DeploymentBlueprintInputType", "workload.DeploymentChangeDetail", "workload.GeneratedObject", "workload.RenameRequest", "workload.ResourceConstraint", "workload.StateAggregation", "x509.Certificate" ], "x-enum-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.", "type": "string", "enum": [ "aaa.UserAgent", "access.AddressType", "access.ConfigurationType", "adapter.AdapterConfig", "adapter.DceInterfaceSettings", "adapter.EthSettings", "adapter.FcSettings", "adapter.PhysicalNicModeSettings", "adapter.PortChannelSettings", "apic.FabricLeafNodeDetails", "appliance.ApiStatus", "appliance.CertRenewalPhase", "appliance.ClusterInstallPhase", "appliance.KeyValuePair", "appliance.MetadataManifestVersion", "appliance.NetworkStatus", "appliance.NodeIpInfo", "appliance.StatusCheck", "asset.AddressInformation", "asset.AlarmSummary", "asset.ApiKeyCredential", "asset.ClientCertificateCredential", "asset.CloudConnection", "asset.ConnectionFlapStatus", "asset.ContractInformation", "asset.CustomerInformation", "asset.DeploymentAlarmInfo", "asset.DeploymentDeviceAlarmInfo", "asset.DeploymentDeviceInformation", "asset.DeviceEndpointLocalCredential", "asset.DeviceInformation", "asset.DeviceStatistics", "asset.DeviceTransaction", "asset.GenericTargetClaimOptions", "asset.GlobalUltimate", "asset.GoogleCloudPlatformServiceAccountKeyCredential", "asset.HttpConnection", "asset.IntersightDeviceConnectorConnection", "asset.MerakiCloudOptions", "asset.MeteringType", "asset.NewRelicCredential", "asset.NoAuthenticationCredential", "asset.OauthBearerTokenCredential", "asset.OauthClientIdSecretCredential", "asset.OrchestrationCivpVmwareVcenterOptions", "asset.OrchestrationHitachiVirtualStoragePlatformOptions", "asset.OrchestrationHsmVmwareVcenterOptions", "asset.OrchestrationService", "asset.ParentConnectionSignature", "asset.PrivateKeyCredential", "asset.ProductInformation", "asset.ScopedTargetConnection", "asset.ServiceNowCredential", "asset.SplunkTokenCredential", "asset.SshConnection", "asset.SudiInfo", "asset.TargetKey", "asset.TargetSignature", "asset.TargetStatusDetails", "asset.TerraformIntegrationService", "asset.TerraformIntegrationTerraformAgentOptions", "asset.TerraformIntegrationTerraformCloudOptions", "asset.Token", "asset.UsernamePasswordCredential", "asset.VirtualizationAmazonWebServiceOptions", "asset.VirtualizationService", "asset.VmHost", "asset.WorkloadOptimizerAmazonWebServicesBillingOptions", "asset.WorkloadOptimizerDynatraceOptions", "asset.WorkloadOptimizerGoogleCloudPlatformBillingOptions", "asset.WorkloadOptimizerHypervOptions", "asset.WorkloadOptimizerMicrosoftAzureApplicationInsightsOptions", "asset.WorkloadOptimizerMicrosoftAzureBillingOptions", "asset.WorkloadOptimizerMicrosoftAzureEnterpriseAgreementOptions", "asset.WorkloadOptimizerMicrosoftAzureServicePrincipalOptions", "asset.WorkloadOptimizerMicrosoftSqlServerOptions", "asset.WorkloadOptimizerNewRelicOptions", "asset.WorkloadOptimizerOpenStackOptions", "asset.WorkloadOptimizerOracleDatabaseServerOptions", "asset.WorkloadOptimizerRedHatOpenStackOptions", "asset.WorkloadOptimizerService", "asset.WorkloadOptimizerVmwareVcenterOptions", "auditd.LogMonitorType", "bios.C845ServerBiosConfiguration", "bios.CbsCmnApbdisC845BiosToken", "bios.CbsCmnCpuAvx512C845BiosToken", "bios.CbsCmnCpuCpbC845BiosToken", "bios.CbsCmnCpuDowncoreModeC845BiosToken", "bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken", "bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken", "bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken", "bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken", "bios.CbsCmnCpuSmeeC845BiosToken", "bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken", "bios.CbsCmnCxlMemOnlineOfflineC845BiosToken", "bios.CbsCmnDeterminismCtlC845BiosToken", "bios.CbsCmnDeterminismEnableC845BiosToken", "bios.CbsCmnGnbNbIommuC845BiosToken", "bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken", "bios.CbsCmnMemCsInterleaveDdrC845BiosToken", "bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken", "bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken", "bios.CbsCmnMemDramRefreshRateC845BiosToken", "bios.CbsCmnMemDramScrubTimeC845BiosToken", "bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken", "bios.CbsCmnMemHealingBistExecutionModeC845BiosToken", "bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken", "bios.CbsCmnMemTsmeEnableDdrC845BiosToken", "bios.CbsCmnPcieCaplinkSpeedC845BiosToken", "bios.CbsCpuCcdCtrlC845BiosToken", "bios.CbsCpuSmtCtrlC845BiosToken", "bios.CbsDbgCpuLapicModeC845BiosToken", "bios.CbsDbgCpuSnpMemCoverC845BiosToken", "bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken", "bios.CbsDfCmnAcpiSratL3NumaC845BiosToken", "bios.CbsDfCmnDramNpsC845BiosToken", "bios.CbsSevSnpSupportC845BiosToken", "bios.Cpu005C845BiosToken", "bios.Ipmi100C845BiosToken", "bios.Ipmi103C845BiosToken", "bios.Ipmi104C845BiosToken", "bios.Ipmi105C845BiosToken", "bios.Nvlck002C845BiosToken", "bios.Nwsk001C845BiosToken", "bios.Nwsk002C845BiosToken", "bios.Nwsk006C845BiosToken", "bios.Nwsk007C845BiosToken", "bios.Pcid001C845BiosToken", "bios.Pcid002C845BiosToken", "bios.Pcid003C845BiosToken", "bios.Ptt000C845BiosToken", "bios.Tcg001C845BiosToken", "bios.Tcg003C845BiosToken", "bios.Tcg007C845BiosToken", "bios.Tcg018C845BiosToken", "bios.Tcg019C845BiosToken", "bios.Ter001C845BiosToken", "bios.Ter0021C845BiosToken", "bios.Ter012C845BiosToken", "bios.Ter05dC845BiosToken", "blueprint.BlueprintDefinitionDependency", "blueprint.GeneratedObjectMetadata", "blueprint.GeneratedObjectNew", "blueprint.GeneratedObjectOperationTarget", "blueprint.GeneratedObjectSourceClone", "blueprint.GeneratedObjectSourceLookup", "blueprint.GeneratedObjectSourceMerge", "blueprint.GeneratedObjectSourceReference", "blueprint.GeneratedObjectSourceSelector", "blueprint.InputOperationType", "blueprint.PreGenerateOperation", "blueprint.PropertyIteration", "blueprint.ResourceConstraints", "blueprint.ServiceItemDefinition", "boot.Bootloader", "boot.FlexMmc", "boot.Http", "boot.Iscsi", "boot.LocalCdd", "boot.LocalDisk", "boot.Nvme", "boot.PchStorage", "boot.Pxe", "boot.San", "boot.SdCard", "boot.StaticIpV4Settings", "boot.StaticIpV6Settings", "boot.UefiShell", "boot.Usb", "boot.VirtualMedia", "bulk.HttpHeader", "bulk.MultiRelationEntryPatch", "bulk.PatchContent", "bulk.RelatedTypeExportOption", "bulk.RestResult", "bulk.RestSubRequest", "bulk.SecResourceRoles", "bulk.SubRequestsGroup", "capability.AdapterConnectionPoint", "capability.CertificatePropertyConstraints", "capability.DeviceInventory", "capability.FeatureConfig", "capability.GpuConnectionPoint", "capability.HsuIsoModelSpecificConstraint", "capability.LdapBasePropertyConstraints", "capability.PcIdRange", "capability.PortPropertyConstraints", "capability.PortRange", "capability.ServerComponentConstraint", "capability.ServerPcieConnectivityLayout", "capability.ServerPcieTopology", "capability.SwitchControlPolicyConstraints", "capability.SwitchNetworkLimits", "capability.SwitchStorageLimits", "capability.SwitchSystemLimits", "capability.SwitchingModeCapability", "capability.UnsupportedFeatureConfig", "capability.UpdateOrderListType", "certificatemanagement.Imc", "certificatemanagement.RootCaCertificate", "chassis.ChassisAssignment", "cloud.TfcWorkspaceVariables", "cmrf.CmRf", "comm.GeoLocationDetails", "comm.GeoPoint", "comm.IpV4AddressBlock", "comm.IpV4Interface", "comm.IpV6Interface", "comm.PhysicalAddress", "comm.TagUsage", "compute.AdapterUnitConfig", "compute.AdapterUnitPropFilter", "compute.AlarmSummary", "compute.CpuConfig", "compute.GpuConfig", "compute.GpuPropFilter", "compute.IpAddress", "compute.MigrationKeyInfo", "compute.PcieZone", "compute.PendingWorkflowTrigger", "compute.PersistentMemoryModule", "compute.PersistentMemoryOperation", "compute.PersonalitySetting", "compute.RecoveryKeyDetails", "compute.ScrubOpConfigutation", "compute.ServerConfig", "compute.ServerOpStatus", "compute.StorageControllerOperation", "compute.StoragePhysicalDrive", "compute.StoragePhysicalDriveOperation", "compute.StorageUtilityImageOperation", "compute.StorageVirtualDrive", "compute.StorageVirtualDriveOperation", "cond.AdapterBaselineStatus", "cond.AdapterDetail", "cond.AdapterInstance", "cond.AlarmAction", "cond.AlarmClassificationEligibility", "cond.AlarmPreview", "cond.AlarmRuleExpression", "cond.AlarmSpec", "cond.AlarmSummary", "cond.AlarmSuppressionDryRunSummary", "cond.FilterRule", "cond.ServerBaselineStatus", "connector.CloseStreamMessage", "connector.CommandControlMessage", "connector.CommandTerminalStream", "connector.EventLog", "connector.ExpectPrompt", "connector.FetchStreamMessage", "connector.FileChecksum", "connector.FileMessage", "connector.HttpRequest", "connector.SshConfig", "connector.SshMessage", "connector.StartStream", "connector.StartStreamFromDevice", "connector.StreamAcknowledge", "connector.StreamInput", "connector.StreamKeepalive", "connector.TargetChangeMessage", "connector.TargetSpecification", "connector.Url", "connector.WinrmRequest", "connector.XmlApiMessage", "connectorpack.ConnectorPackUpdate", "content.ComplexType", "content.Parameter", "content.TextParameter", "convergedinfra.AlarmSummary", "convergedinfra.ComplianceSummary", "convergedinfra.PodSummary", "crd.CustomResourceConfigProperty", "equipment.ChassisOperationStatus", "equipment.ChassisOperationsDetails", "equipment.DeviceLocation", "equipment.IoCardIdentity", "equipment.IoCardOperationStatus", "equipment.PendingWorkflowTrigger", "equipment.ResetAction", "ether.MacsecOperData", "fabric.ChassisAssignment", "fabric.ClusterAssignment", "fabric.FcZoneMember", "fabric.FlowNonKey", "fabric.Ipv4FlowKey", "fabric.Ipv6FlowKey", "fabric.L2FlowKey", "fabric.LldpGlobalSettings", "fabric.LldpSettings", "fabric.MacAgingSettings", "fabric.MacLearningSettings", "fabric.MacSecEaPol", "fabric.PfcWatchDog", "fabric.PortIdentifier", "fabric.QosClass", "fabric.SecKey", "fabric.SecKeyChain", "fabric.StpGlobalSettings", "fabric.SwitchAssignment", "fabric.UdldGlobalSettings", "fabric.UdldSettings", "fabric.VlanExportInterface", "fabric.VlanSettings", "fcpool.Block", "fcpool.ReservationReference", "feedback.FeedbackData", "filterexpr.AndFilterExpression", "filterexpr.OrFilterExpression", "filterexpr.PredicateFilterExpression", "firmware.ChassisUpgradeImpact", "firmware.CifsServer", "firmware.ComponentImpact", "firmware.ComponentMeta", "firmware.DirectDownload", "firmware.ExcludeComponentPidListType", "firmware.FabricUpgradeImpact", "firmware.FeatureVersionMap", "firmware.FirmwareInventory", "firmware.HttpServer", "firmware.ModelBundleVersion", "firmware.NetworkShare", "firmware.NfsServer", "firmware.ServerImpact", "firmware.ServerUpgradeImpact", "firmware.VersionMap", "forecast.Model", "hci.AhvGuestTools", "hci.AlarmParameter", "hci.AlarmSummary", "hci.ApiLimit", "hci.BackplaneNetworkParams", "hci.CapacityViolation", "hci.ClusterOpInfo", "hci.ConfigurableParamValue", "hci.ConfigurableParamValueRange", "hci.Consumption", "hci.EntitlementDetail", "hci.EsxiGuestTools", "hci.ExpiredLicense", "hci.ExternalStorageArray", "hci.FaultToleranceState", "hci.FeatureViolation", "hci.IpAddress", "hci.IpAddressOrFqdn", "hci.KeyManagementDeviceToCertStatusInfo", "hci.LicensedService", "hci.ManagementServer", "hci.NccConfigurableParameter", "hci.NutanixClusterCheck", "hci.PendingWorkflowTrigger", "hci.PulseStatus", "hci.Sbdf", "hci.SdaPolicyClusterConfig", "hci.ServiceViolation", "hci.SoftwareType", "hci.VirtualGpuConfig", "hcl.Constraint", "hcl.Firmware", "hcl.HardwareCompatibilityProfile", "hcl.Product", "hcl.ServerConfiguration", "hyperflex.AlarmSummary", "hyperflex.AppSettingConstraint", "hyperflex.BackupPolicySettings", "hyperflex.Capability", "hyperflex.DatastoreInfo", "hyperflex.EntityReference", "hyperflex.ErrorStack", "hyperflex.FeatureLimitEntry", "hyperflex.FilePath", "hyperflex.HealthCheckNodeLevelInfo", "hyperflex.HealthCheckScriptInfo", "hyperflex.HxHostMountStatusDt", "hyperflex.HxLicenseAuthorizationDetailsDt", "hyperflex.HxLinkDt", "hyperflex.HxNetworkAddressDt", "hyperflex.HxPlatformDatastoreConfigDt", "hyperflex.HxRegistrationDetailsDt", "hyperflex.HxResiliencyInfoDt", "hyperflex.HxSiteDt", "hyperflex.HxUuIdDt", "hyperflex.HxZoneInfoDt", "hyperflex.HxZoneResiliencyInfoDt", "hyperflex.IpAddrRange", "hyperflex.LogicalAvailabilityZone", "hyperflex.MacAddrPrefixRange", "hyperflex.MapClusterIdToProtectionInfo", "hyperflex.MapClusterIdToStSnapshotPoint", "hyperflex.MapUuidToTrackedDisk", "hyperflex.NamedVlan", "hyperflex.NamedVsan", "hyperflex.NetworkConfiguration", "hyperflex.PortTypeToPortNumberMap", "hyperflex.ProtectionInfo", "hyperflex.ReSyncClusterMoIds", "hyperflex.ReplicationClusterReferenceToSchedule", "hyperflex.ReplicationPeerInfo", "hyperflex.ReplicationPlatDatastore", "hyperflex.ReplicationPlatDatastorePair", "hyperflex.ReplicationSchedule", "hyperflex.ReplicationStatus", "hyperflex.RpoStatus", "hyperflex.ServerFirmwareVersionInfo", "hyperflex.ServerModelEntry", "hyperflex.SiteDetails", "hyperflex.SnapshotFiles", "hyperflex.SnapshotInfoBrief", "hyperflex.SnapshotPoint", "hyperflex.SnapshotStatus", "hyperflex.StPlatformClusterHealingInfo", "hyperflex.StPlatformClusterResiliencyInfo", "hyperflex.Summary", "hyperflex.TrackedDisk", "hyperflex.TrackedFile", "hyperflex.VcenterConfiguration", "hyperflex.VirtualMachine", "hyperflex.VirtualMachineRuntimeInfo", "hyperflex.VmProtectionSpaceUsage", "hyperflex.WwxnPrefixRange", "i18n.Message", "i18n.MessageParam", "iaas.LicenseKeysInfo", "iaas.LicenseUtilizationInfo", "iaas.WorkflowSteps", "iam.AccountPermissions", "iam.AccountTags", "iam.AccountTypeIpmi", "iam.AccountTypeLocal", "iam.BasicAuthCredentials", "iam.ClientMeta", "iam.DefaultPermissionInfo", "iam.EncryptedOidcAuthTokenSet", "iam.EndPointPasswordProperties", "iam.FailureDetails", "iam.FeatureDefinition", "iam.GroupPermissionToRoles", "iam.LdapBaseProperties", "iam.LdapDnsParameters", "iam.OidcAuthTokenSet", "iam.PasswordHistorySetting", "iam.PermissionReference", "iam.PermissionToRoles", "iam.ResourceRole", "iam.Rule", "iam.SamlSpConnection", "iam.SecurityContext", "iam.SsoSessionAttributes", "iam.SwitchAccountPermission", "iam.SwitchScopePermissions", "iam.TenantLinking", "iam.UserDetails", "imcconnector.WebUiMessage", "infra.GpuConfiguration", "infra.HardwareInfo", "infra.MetaData", "infra.MigGpuConfiguration", "inventory.InventoryMo", "inventory.JobInfo", "inventory.UemInfo", "ippool.IpV4Block", "ippool.IpV4Config", "ippool.IpV6Block", "ippool.IpV6Config", "ippool.ReservationReference", "iqnpool.IqnSuffixBlock", "iqnpool.ReservationReference", "issue.DeviceTag", "issue.Message", "issue.OdataCondition", "license.SubstituteLicense", "macpool.Block", "macpool.MemberOf", "macpool.ReservationReference", "management.ReplayConfigInfo", "memory.PersistentMemoryGoal", "memory.PersistentMemoryLocalSecurity", "memory.PersistentMemoryLogicalNamespace", "meta.AccessPrivilege", "meta.DisplayNameDefinition", "meta.IdentityDefinition", "meta.PropDefinition", "meta.RelationshipDefinition", "metric.SeverityCriteria", "metric.ThresholdCondition", "metric.ThresholdDefinitionState", "metrics.MetricCriterion", "mgmt.BackupOptions", "mgmt.CategoryExportData", "mgmt.CategoryImportData", "mgmt.ChildTypeInfo", "mgmt.ConfigObjectDetails", "mgmt.ConfigObjectRestoreDetails", "mgmt.RestoreOptions", "mgmt.TypeWithFilter", "mo.MoRef", "mo.Tag", "mo.VersionContext", "monitoring.CategoryStatus", "motemplate.ActionEntry", "motemplate.ActionParam", "motemplate.SyncError", "network.HyperFlexInternetProtocolAddressRange", "network.HyperFlexNetworkAddress", "network.SecureRouterInfo", "niaapi.Detail", "niaapi.NewReleaseDetail", "niaapi.RevisionInfo", "niaapi.SoftwareRegex", "niaapi.VersionRegexPlatform", "niatelemetry.Advisories", "niatelemetry.BootflashDetails", "niatelemetry.CloudRegionsElement", "niatelemetry.CloudRoutersElement", "niatelemetry.DeploymentStatus", "niatelemetry.DigitalOpticalMonitoring", "niatelemetry.Diskinfo", "niatelemetry.DomInfo", "niatelemetry.DomThresInfo", "niatelemetry.EqptStorageFirmware", "niatelemetry.EqptcapacityPolUsage5min", "niatelemetry.EqptcapacityPrefixEntries15min", "niatelemetry.EqptcapacityPrefixEntries5min", "niatelemetry.FanDetails", "niatelemetry.ImageDetail", "niatelemetry.Interface", "niatelemetry.InterfaceElement", "niatelemetry.JobDetail", "niatelemetry.LogicalLink", "niatelemetry.MdsNeighborInfo", "niatelemetry.NetworkInfo", "niatelemetry.Node", "niatelemetry.NvePacketCounters", "niatelemetry.NveVni", "niatelemetry.NxosBgpEvpn", "niatelemetry.NxosBgpMvpn", "niatelemetry.NxosModuleInfo", "niatelemetry.NxosVtp", "niatelemetry.ProcSysCpu15min", "niatelemetry.ProcSysCpu5min", "niatelemetry.ProcSysMem15min", "niatelemetry.ProcSysMem5min", "niatelemetry.RouteNextHop", "niatelemetry.Sites", "niatelemetry.SmartLicense", "niatelemetry.SwitchDiskUtilization", "niatelemetry.VniStatus", "niatelemetry.VpcDetails", "notification.AdvisoryMoCondition", "notification.AggregationSettings", "notification.AlarmMoCondition", "notification.ApplianceUpgradeMoCondition", "notification.DistributableMoCondition", "notification.EolAdvisoryFilter", "notification.FieldNoticeAdvisoryFilter", "notification.HttpHeader", "notification.MoCondition", "notification.SecurityAdvisoryFilter", "notification.SendEmail", "notification.SimpleFilter", "notification.SimpleMoCondition", "notification.SoftwareReleaseMetaMoCondition", "notification.TriggerWebhook", "ntp.AuthNtpServer", "onprem.ClusterInfo", "onprem.ClusterNode", "onprem.ImagePackage", "onprem.ResourceInfo", "onprem.Schedule", "onprem.UpgradeNote", "onprem.UpgradePhase", "openapi.ApiInfo", "openapi.FailedTask", "openapi.KeyValuePair", "oprs.Kvpair", "os.Answers", "os.FibreChannelResponse", "os.FibreChannelTarget", "os.GlobalConfig", "os.Ipv4Configuration", "os.Ipv6Configuration", "os.IscsiLunResponse", "os.IscsiTarget", "os.PhysicalDisk", "os.PhysicalDiskResponse", "os.PlaceHolder", "os.ServerConfig", "os.ValidationInformation", "os.VirtualDrive", "os.VirtualDriveResponse", "os.VmwareParameters", "os.WindowsParameters", "partnerintegration.MetricsModel", "pkix.DistinguishedName", "pkix.EcdsaKeySpec", "pkix.EddsaKeySpec", "pkix.RsaAlgorithm", "pkix.SubjectAlternateName", "policy.ActionParam", "policy.ActionQualifier", "policy.ConfigChange", "policy.ConfigChangeContext", "policy.ConfigChangeDetailType", "policy.ConfigChangeDisruptionDetailType", "policy.ConfigContext", "policy.ConfigResultContext", "policy.PolicyContextHolder", "policy.PolicyError", "policy.PolicyStatus", "policy.Qualifier", "policy.ReportedPolicyChange", "policy.ScheduledAction", "recovery.BackupSchedule", "resource.AdaptorsRangeFilter", "resource.BladeQualifier", "resource.ChassisAndSlotQualification", "resource.ChassisIdRangeFilter", "resource.ChassisServersQualifier", "resource.CpuCoreRangeFilter", "resource.CpuSpeedRangeFilter", "resource.DomainQualifier", "resource.GpuControllersRangeFilter", "resource.GpuQualifier", "resource.MemoryCapacityRangeFilter", "resource.MemoryQualifier", "resource.MemoryUnitsRangeFilter", "resource.NetworkAdaptorQualifier", "resource.OdataRuleSetQualifier", "resource.PerTypeCombinedSelector", "resource.ProcessorQualifier", "resource.RackIdRangeFilter", "resource.RackServerQualifier", "resource.Selector", "resource.SlotIdRangeFilter", "resource.SourceToPermissionResources", "resource.SourceToPermissionResourcesHolder", "resource.Tag", "resource.TagQualifier", "resourcepool.ChildLeaseCondition", "resourcepool.QualificationType", "resourcepool.ReservationReference", "resourcepool.ResourceEvaluationStatus", "resourcepool.ServerLeaseParameters", "resourcepool.ServerPoolParameters", "scheduler.BlockDate", "scheduler.DailyCadenceParams", "scheduler.EveryCadenceParams", "scheduler.MonthlyCadenceParams", "scheduler.OneTimeScheduleParams", "scheduler.RecurringScheduleParams", "scheduler.RestStimTaskRequest", "scheduler.TaskResultStatus", "scheduler.TaskSchedulePolicyExecutionStatus", "scheduler.TaskScheduleStatus", "scheduler.WeeklyCadenceParams", "sdcard.Diagnostics", "sdcard.Drivers", "sdcard.HostUpgradeUtility", "sdcard.OperatingSystem", "sdcard.Partition", "sdcard.ServerConfigurationUtility", "sdcard.UserPartition", "server.DiagnosticResult", "server.PendingWorkflowTrigger", "server.ServerAssignTypeSlot", "server.ServerAssignment", "serviceitem.HealthCheckErrorElement", "serviceitem.Message", "serviceitem.SelectionCriteriaInput", "servicerequest.Message", "snmp.Trap", "snmp.User", "softwarerepository.ApplianceUpload", "softwarerepository.CifsServer", "softwarerepository.ConstraintModels", "softwarerepository.HttpServer", "softwarerepository.ImportResult", "softwarerepository.LocalMachine", "softwarerepository.NfsServer", "softwarerepository.UnsupportedModelConstraint", "storage.AutomaticDriveGroup", "storage.ExternalLun", "storage.ExternalParityGroup", "storage.ExternalPath", "storage.HitachiArrayUtilization", "storage.HitachiCapacity", "storage.HitachiInitiator", "storage.HostNqn", "storage.HyperFlexIscsiInitiator", "storage.Initiator", "storage.InternalMoPhysicalDiskConfig", "storage.KeySetting", "storage.KmipAuthCredentials", "storage.KmipServer", "storage.LocalKeySetting", "storage.M2VirtualDriveConfig", "storage.ManualDriveGroup", "storage.Namespace", "storage.NamespacePath", "storage.NetAppAutoSupport", "storage.NetAppCifsAcl", "storage.NetAppEthernetPortLag", "storage.NetAppEthernetPortVlan", "storage.NetAppExportPolicyRule", "storage.NetAppHighAvailability", "storage.NetAppPerformanceMetricsAverage", "storage.NetAppPort", "storage.NetAppSnapshotPolicySchedule", "storage.NetAppStorageClusterEfficiency", "storage.NetAppStorageUtilization", "storage.NvmeDedicatedHotSpareConfiguration", "storage.NvmePhysicalDiskState", "storage.NvmeRaidDriveGroup", "storage.NvmeVirtualDriveConfiguration", "storage.PureArrayUtilization", "storage.PureDiskUtilization", "storage.PureFlashBladeUtilization", "storage.PureHostUtilization", "storage.PurePodUtilization", "storage.PureRealmUtilization", "storage.PureReplicationBlackout", "storage.PureVolumeUtilization", "storage.R0Drive", "storage.RemoteKeySetting", "storage.Space", "storage.SpanDrives", "storage.StorageContainerHostMountStatus", "storage.StorageContainerUtilization", "storage.VirtualDriveConfiguration", "storage.VirtualDrivePolicy", "storage.VolumeUtilization", "syslog.LocalFileLoggingClient", "syslog.RemoteLoggingClient", "tam.Action", "tam.ApiDataSource", "tam.EolAdvisoryDetails", "tam.EolSeverity", "tam.FnSeverity", "tam.Identifiers", "tam.Milestone", "tam.PsirtSeverity", "tam.QueryEntry", "tam.S3DataSource", "tam.SecurityAdvisoryDetails", "tam.TextFsmTemplateDataSource", "techsupportmanagement.ApplianceParam", "techsupportmanagement.NiaParam", "techsupportmanagement.PlatformParam", "techsupportmanagement.TechSupportFileInfo", "template.TransformationStage", "ucsd.ConnectorPack", "ucsd.UcsdRestoreParameters", "ucsdconnector.RestClientMessage", "uuidpool.ReservationReference", "uuidpool.UuidBlock", "virtualization.ActionInfo", "virtualization.CloudInitConfig", "virtualization.ComputeCapacity", "virtualization.CpuInfo", "virtualization.EsxiCloneCustomSpec", "virtualization.EsxiHostConfiguration", "virtualization.EsxiOvaCustomSpec", "virtualization.EsxiVmComputeConfiguration", "virtualization.EsxiVmConfiguration", "virtualization.EsxiVmNetworkConfiguration", "virtualization.EsxiVmStorageConfiguration", "virtualization.GuestInfo", "virtualization.MemoryCapacity", "virtualization.NetworkInterface", "virtualization.ProductInfo", "virtualization.StorageCapacity", "virtualization.VirtualMachineDisk", "virtualization.VmEsxiDisk", "virtualization.VmwareAttachedResourceTag", "virtualization.VmwareDiscoveryProtocol", "virtualization.VmwareRemoteDisplayInfo", "virtualization.VmwareResourceAllocationSystemTrafficTypes", "virtualization.VmwareResourceConsumption", "virtualization.VmwareSharesInfo", "virtualization.VmwareTeamingAndFailover", "virtualization.VmwareVlanRange", "virtualization.VmwareVmCpuShareInfo", "virtualization.VmwareVmCpuSocketInfo", "virtualization.VmwareVmDiskCommitInfo", "virtualization.VmwareVmMemoryShareInfo", "vmedia.Mapping", "vnic.ArfsSettings", "vnic.Cdn", "vnic.CompletionQueueSettings", "vnic.EthIfOldInfo", "vnic.EthInterruptSettings", "vnic.EthRxQueueSettings", "vnic.EthTxQueueSettings", "vnic.FcErrorRecoverySettings", "vnic.FcIfOldInfo", "vnic.FcInterruptSettings", "vnic.FcQueueSettings", "vnic.FlogiSettings", "vnic.IscsiAuthProfile", "vnic.Lun", "vnic.NetFlowMonitorSession", "vnic.NvgreSettings", "vnic.PlacementSettings", "vnic.PlogiSettings", "vnic.PtpSettings", "vnic.RoceSettings", "vnic.RssHashSettings", "vnic.SanSettingsOldInfo", "vnic.ScsiQueueSettings", "vnic.SriovSettings", "vnic.TcpOffloadSettings", "vnic.UsnicSettings", "vnic.VifStatus", "vnic.VlanSettings", "vnic.VmqSettings", "vnic.VsanSettings", "vnic.VxlanSettings", "workflow.AnsiblePlaySession", "workflow.ArrayDataType", "workflow.AssociatedRoles", "workflow.CancelableType", "workflow.CliCommand", "workflow.Comments", "workflow.Constraints", "workflow.CustomArrayItem", "workflow.CustomDataProperty", "workflow.CustomDataType", "workflow.CustomDataTypeProperties", "workflow.DataSourceSelector", "workflow.DecisionCase", "workflow.DecisionTask", "workflow.DefaultValue", "workflow.DisplayMeta", "workflow.DynamicTemplateParserDataType", "workflow.EnumEntry", "workflow.EnvironmentVariableReference", "workflow.ExpectPrompt", "workflow.FailureEndTask", "workflow.FileDownloadOp", "workflow.FileOperations", "workflow.FileTemplateOp", "workflow.FileTransfer", "workflow.ForkTask", "workflow.InitiatorContext", "workflow.InternalProperties", "workflow.JoinTask", "workflow.LoopTask", "workflow.Message", "workflow.MigrateServiceItemActionProperty", "workflow.MigrationHistory", "workflow.MoInventoryDataType", "workflow.MoInventoryProperty", "workflow.MoReferenceArrayItem", "workflow.MoReferenceAutoArrayItem", "workflow.MoReferenceAutoDataType", "workflow.MoReferenceAutoProperty", "workflow.MoReferenceDataType", "workflow.MoReferenceForCloneDataType", "workflow.MoReferenceProperty", "workflow.OperationTypeDecommission", "workflow.OperationTypeDeployment", "workflow.OperationTypePostDeployment", "workflow.ParameterSet", "workflow.PowerShellApi", "workflow.PrimitiveArrayItem", "workflow.PrimitiveDataProperty", "workflow.PrimitiveDataType", "workflow.Properties", "workflow.ResourceInlineSelector", "workflow.ResourceSelectorCriteria", "workflow.ResultHandler", "workflow.RollbackTask", "workflow.RollbackWorkflowTask", "workflow.SelectorProperty", "workflow.SequenceParams", "workflow.SerialLoopTask", "workflow.ServiceItemActionProperties", "workflow.ServiceItemActionWorkflowDefinition", "workflow.ServiceItemInputDefinitionType", "workflow.ServiceItemType", "workflow.SshCmd", "workflow.SshConfig", "workflow.SshSession", "workflow.StartTask", "workflow.SubWorkflowTask", "workflow.SuccessEndTask", "workflow.TargetContext", "workflow.TargetDataType", "workflow.TargetProperty", "workflow.TaskConstraints", "workflow.TaskInfoUpdate", "workflow.TaskLoopInfo", "workflow.TaskRetryInfo", "workflow.UiFormConfig", "workflow.UiInputFilter", "workflow.UiViewConfig", "workflow.ValidationError", "workflow.ValidationInformation", "workflow.WaitTask", "workflow.WaitTaskPrompt", "workflow.WebApi", "workflow.WorkerTask", "workflow.WorkflowCtx", "workflow.WorkflowEngineProperties", "workflow.WorkflowInfoAutoRestartProperties", "workflow.WorkflowInfoProperties", "workflow.WorkflowProperties", "workflow.XmlApi", "workload.AssignedResource", "workload.BatchDeployment", "workload.BlueprintInputReference", "workload.BlueprintReference", "workload.CanaryDeployment", "workload.CloneStatus", "workload.CloneStatusEntry", "workload.DefinitionMapper", "workload.DeploymentBlueprintInputType", "workload.DeploymentChangeDetail", "workload.GeneratedObject", "workload.RenameRequest", "workload.ResourceConstraint", "workload.StateAggregation", "x509.Certificate" ], "x-enum-as-string": true } } }, "mo.BaseMo.Relationship": { "description": "A relationship to the 'mo.BaseMo' resource, or the expanded 'mo.BaseMo' resource, or the 'null' value.", "x-one-of-name": "mo.BaseMo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/mo.BaseMo" } ], "discriminator": { "propertyName": "ClassId" } }, "mo.BaseMo": { "type": "object", "discriminator": { "propertyName": "ClassId" }, "title": "Mo:Base Mo", "description": "The base abstract class for all Cisco Intersight managed objects.", "required": [ "ClassId", "ObjectType", "objectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.", "type": "string", "enum": [ "aaa.AuditRecord", "aaa.RetentionConfig", "aaa.RetentionPolicy", "access.IpAddress", "access.Policy", "access.PolicyInventory", "adapter.ConfigPolicy", "adapter.ExtEthInterface", "adapter.HostEthInterface", "adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "apic.AciPod", "apic.Application", "apic.ApplicationEndpointGroup", "apic.BridgeDomain", "apic.ExternalRoutedLayerThreeDomain", "apic.FabricLeafNode", "apic.FabricLeafNodeInterface", "apic.Out", "apic.Subnet", "apic.Tenant", "apic.VpcGroup", "apic.Vrfs", "apiproxy.AllowList", "appliance.AppOpStatus", "appliance.AppStatus", "appliance.AutoRmaPolicy", "appliance.Backup", "appliance.BackupDownload", "appliance.BackupMonitor", "appliance.BackupPolicy", "appliance.BackupRotateData", "appliance.CertificateSetting", "appliance.ClusterInfo", "appliance.ClusterInstall", "appliance.ClusterReplaceNode", "appliance.ClusterWorkerNode", "appliance.ClusterWorkerNodeReplace", "appliance.ClusterWorkerNodeReuse", "appliance.CpuUtilization", "appliance.DataExportPolicy", "appliance.DeviceCertificate", "appliance.DeviceClaim", "appliance.DeviceClusterInstall", "appliance.DeviceState", "appliance.DeviceUpgradePolicy", "appliance.DiagSetting", "appliance.ExternalSyslogSetting", "appliance.FileGateway", "appliance.FileSystemOpStatus", "appliance.FileSystemOpSummary", "appliance.FileSystemStatus", "appliance.FileSystemTelemetry", "appliance.FqdnUpdate", "appliance.GroupOpStatus", "appliance.GroupStatus", "appliance.ImageBundle", "appliance.MemoryUtilization", "appliance.MetaManifest", "appliance.MetricsConfig", "appliance.MetricsIngestionUtilization", "appliance.NetworkLinkStatus", "appliance.NodeInfo", "appliance.NodeIopsMetric", "appliance.NodeOpStatus", "appliance.NodeStatus", "appliance.NodeTelemetry", "appliance.ReleaseNote", "appliance.RemoteFileImport", "appliance.Restore", "appliance.SetupInfo", "appliance.SystemInfo", "appliance.SystemOpStatus", "appliance.SystemStatus", "appliance.Upgrade", "appliance.UpgradePolicy", "appliance.UpgradeTracker", "asset.ClaimToken", "asset.ClusterMember", "asset.Deployment", "asset.DeploymentDevice", "asset.DeviceClaim", "asset.DeviceConfiguration", "asset.DeviceConnectorManager", "asset.DeviceContractInformation", "asset.DeviceContractNotification", "asset.DeviceRegistration", "asset.GeoLocation", "asset.PreClaim", "asset.Subscription", "asset.SubscriptionAccount", "asset.SubscriptionDeviceContractInformation", "asset.Target", "auditd.Policy", "bios.BootDevice", "bios.BootMode", "bios.Policy", "bios.SystemBootOrder", "bios.TokenSettings", "bios.Unit", "bios.VfSelectMemoryRasConfiguration", "boot.CddDevice", "boot.DeviceBootMode", "boot.DeviceBootSecurity", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PrecisionPolicy", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "bulk.Export", "bulk.ExportedItem", "bulk.MoCloner", "bulk.MoDeepCloner", "bulk.MoMerger", "bulk.Request", "bulk.Result", "bulk.SubRequestObj", "capability.ActionsMetaData", "capability.AdapterDeprecatedDef", "capability.AdapterFirmwareRequirement", "capability.AdapterUnitDescriptor", "capability.AdapterUpdateConstraintMeta", "capability.AdapterUpgradeSupportMeta", "capability.BiosTokens", "capability.Catalog", "capability.ChassisDescriptor", "capability.ChassisManufacturingDef", "capability.ChassisUpgradeSupportMeta", "capability.CimcFirmwareDescriptor", "capability.CpuEndpointDescriptor", "capability.DimmsEndpointDescriptor", "capability.DomainPolicyRequirement", "capability.DrivesEndpointDescriptor", "capability.EquipmentPhysicalDef", "capability.EquipmentSlotArray", "capability.FanModuleDescriptor", "capability.FanModuleManufacturingDef", "capability.FexCapabilityDef", "capability.FexDescriptor", "capability.FexManufacturingDef", "capability.FexSupportMeta", "capability.GpuEndpointDescriptor", "capability.HsuIsoFileSupportMeta", "capability.IoCardCapabilityDef", "capability.IoCardDescriptor", "capability.IoCardManufacturingDef", "capability.IomUpgradeSupportMeta", "capability.NetworkEquipmentPowerDef", "capability.PolicyConstants", "capability.PortGroupAggregationDef", "capability.ProcessorUnitUpdateConstraintMeta", "capability.PsuDescriptor", "capability.PsuManufacturingDef", "capability.ServerActionsMeta", "capability.ServerDescriptor", "capability.ServerModelsCapabilityDef", "capability.ServerPcieConnectivityCatalog", "capability.ServerSchemaDescriptor", "capability.ServerTopologyMap", "capability.ServerUpgradeSupportMeta", "capability.SiocModuleCapabilityDef", "capability.SiocModuleDescriptor", "capability.SiocModuleManufacturingDef", "capability.StandardRedfishSupportMeta", "capability.StorageControllerUpdateConstraintMeta", "capability.StorageControllersMetaData", "capability.SwitchCapability", "capability.SwitchDescriptor", "capability.SwitchEquipmentInfo", "capability.SwitchManufacturingDef", "capability.SwitchUpgradeSupportMeta", "capability.TemplateCatalog", "capability.TimeZoneMetaData", "capability.UpdateOrderMeta", "capability.VicDescriptor", "catalystsdwan.ConfigGroup", "catalystsdwan.Interface", "catalystsdwan.PhysicalPort", "catalystsdwan.PolicyGroup", "catalystsdwan.PortChannel", "catalystsdwan.VedgeDevice", "catalystsdwan.Vlan", "catalystsdwan.WanEdgeDevice", "certificatemanagement.Policy", "certificatemanagement.PolicyInventory", "chassis.ConfigChangeDetail", "chassis.ConfigImport", "chassis.ConfigResult", "chassis.ConfigResultEntry", "chassis.IomProfile", "chassis.Profile", "chassis.ProfileTemplate", "cli.CliPolicy", "cloud.CollectInventory", "cloud.TfcAgentpool", "cloud.TfcOrganization", "cloud.TfcWorkspace", "comm.HttpProxyPolicy", "comm.TagDefinition", "compute.Blade", "compute.BladeIdentity", "compute.Board", "compute.DownloadStatus", "compute.HostUtilityOperation", "compute.Mapping", "compute.PcieConnectivityPolicy", "compute.PcieConnectivityPolicyInventory", "compute.Personality", "compute.PhysicalSummary", "compute.RackUnit", "compute.RackUnitIdentity", "compute.ScrubPolicy", "compute.ServerIdPool", "compute.ServerPowerParameters", "compute.ServerPowerPolicy", "compute.ServerSetting", "compute.Vmedia", "cond.Alarm", "cond.AlarmAggregation", "cond.AlarmClassification", "cond.AlarmDefinition", "cond.AlarmRule", "cond.AlarmSuppression", "cond.AlarmSuppressionDryRun", "cond.CustomHclBaseline", "cond.CustomHclStatus", "cond.HclStatus", "cond.HclStatusDetail", "cond.HclStatusJob", "cond.ThresholdDefinition", "connectorpack.ConnectorPackUpgrade", "connectorpack.UpgradeImpact", "console.ConsoleConfig", "convergedinfra.AdapterComplianceDetails", "convergedinfra.Pod", "convergedinfra.PodComplianceInfo", "convergedinfra.ServerComplianceDetails", "convergedinfra.StorageComplianceDetails", "convergedinfra.SwitchComplianceDetails", "coremanagement.CoreFile", "coremanagement.Download", "crd.CustomResource", "deviceconnector.Policy", "dnac.Device", "dnac.DeviceInterface", "dnac.ExternalBorderNode", "dnac.ExternalBorderNodeInterface", "dnac.FabricSite", "dnac.Site", "dnac.SiteIpPool", "dnac.Template", "dnac.Transit", "dnac.VirtualNetworkFabricSite", "energy.DailyMetrics", "energy.Metrics", "equipment.Chassis", "equipment.ChassisController", "equipment.ChassisIdPool", "equipment.ChassisIdentity", "equipment.ChassisOperation", "equipment.DeviceSummary", "equipment.EnclosureElement", "equipment.EndPointLog", "equipment.ExpanderModule", "equipment.ExpanderModuleIdentity", "equipment.ExpanderModuleOperation", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.FexIdentity", "equipment.FexOperation", "equipment.Fru", "equipment.HybridDriveSlot", "equipment.Interconnect", "equipment.IoCard", "equipment.IoCardOperation", "equipment.IoExpander", "equipment.LocatorLed", "equipment.LogDownload", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.Riser", "equipment.Sensor", "equipment.SharedAdapterUnit", "equipment.SharedGraphicsCard", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SwitchOperation", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "ether.HostPort", "ether.InterSwitchPort", "ether.LanPort", "ether.NetworkPort", "ether.PhysicalPort", "ether.PortChannel", "externalsite.Authorization", "fabric.AppliancePcRole", "fabric.ApplianceRole", "fabric.ConfigChangeDetail", "fabric.ConfigResult", "fabric.ConfigResultEntry", "fabric.ElementIdentity", "fabric.EstimateImpact", "fabric.EthNetworkControlPolicy", "fabric.EthNetworkControlPolicyInventory", "fabric.EthNetworkGroupPolicy", "fabric.EthNetworkGroupPolicyInventory", "fabric.EthNetworkPolicy", "fabric.FcNetworkPolicy", "fabric.FcStorageRole", "fabric.FcUplinkPcRole", "fabric.FcUplinkRole", "fabric.FcZonePolicy", "fabric.FcoeUplinkPcRole", "fabric.FcoeUplinkRole", "fabric.FlowControlPolicy", "fabric.LanPinGroup", "fabric.LinkAggregationPolicy", "fabric.LinkControlPolicy", "fabric.MacSecPolicy", "fabric.MulticastPolicy", "fabric.NetFlowExporter", "fabric.NetFlowMonitor", "fabric.NetFlowPolicy", "fabric.NetFlowRecord", "fabric.PcMember", "fabric.PcOperation", "fabric.PortMode", "fabric.PortOperation", "fabric.PortPolicy", "fabric.SanPinGroup", "fabric.SecureRouterRole", "fabric.ServerRole", "fabric.SpanDestEthPort", "fabric.SpanSession", "fabric.SpanSourceEthPort", "fabric.SpanSourceEthPortChannel", "fabric.SpanSourceVlan", "fabric.SpanSourceVnicEthIf", "fabric.SwitchClusterProfile", "fabric.SwitchClusterProfileTemplate", "fabric.SwitchControlPolicy", "fabric.SwitchProfile", "fabric.SwitchProfileTemplate", "fabric.SystemQosPolicy", "fabric.UplinkPcRole", "fabric.UplinkRole", "fabric.Vlan", "fabric.VlanInventory", "fabric.VlanSet", "fabric.Vsan", "fabric.VsanInventory", "fault.Instance", "fc.Neighbor", "fc.PhysicalPort", "fc.PortChannel", "fcpool.FcBlock", "fcpool.Lease", "fcpool.Pool", "fcpool.PoolMember", "fcpool.Reservation", "fcpool.Universe", "feedback.FeedbackPost", "firmware.BiosDescriptor", "firmware.BoardControllerDescriptor", "firmware.ChassisUpgrade", "firmware.CimcDescriptor", "firmware.DimmDescriptor", "firmware.Distributable", "firmware.DistributableMeta", "firmware.DriveDescriptor", "firmware.DriverDistributable", "firmware.Eula", "firmware.FirmwareSummary", "firmware.GpuDescriptor", "firmware.HbaDescriptor", "firmware.IomDescriptor", "firmware.MswitchDescriptor", "firmware.NxosDescriptor", "firmware.PciNodeUpgrade", "firmware.PcieDescriptor", "firmware.Policy", "firmware.PsuDescriptor", "firmware.PsxDescriptor", "firmware.RunningFirmware", "firmware.SasExpanderDescriptor", "firmware.SecureRouterUpgrade", "firmware.ServerConfigurationUtilityDistributable", "firmware.StorageControllerDescriptor", "firmware.SwitchUpgrade", "firmware.UnsupportedVersionUpgrade", "firmware.Upgrade", "firmware.UpgradeImpact", "firmware.UpgradeImpactStatus", "firmware.UpgradeStatus", "firmware.UpgradeValidity", "fmc.Device", "fmc.DeviceHaPair", "fmc.Domain", "fmc.PhysicalInterface", "forecast.Catalog", "forecast.Definition", "forecast.Instance", "graphics.Card", "graphics.Controller", "hci.AhvVm", "hci.AhvVmDisk", "hci.AhvVmGpu", "hci.AhvVmNic", "hci.Alarm", "hci.Cluster", "hci.ClusterOperation", "hci.Compliance", "hci.Disk", "hci.DomainManager", "hci.Entitlement", "hci.EsxiVm", "hci.EsxiVmDisk", "hci.EsxiVmNic", "hci.ExternalStorage", "hci.Gpu", "hci.License", "hci.NccCheckPolicy", "hci.Node", "hci.PhysicalGpu", "hci.StorageContainer", "hci.Violation", "hci.VirtualGpu", "hcl.CompatibilityStatus", "hcl.DataImportLog", "hcl.DriverImage", "hcl.ExemptedCatalog", "hcl.HwCatalogInfo", "hcl.HyperflexSoftwareCompatibilityInfo", "hcl.OperatingSystem", "hcl.OperatingSystemVendor", "hcl.ServerCatalog", "hcl.ServerHwCatalogInfo", "hcl.SupportedDriverName", "hyperflex.Alarm", "hyperflex.AppCatalog", "hyperflex.AutoSupportPolicy", "hyperflex.BackupCluster", "hyperflex.CapabilityInfo", "hyperflex.Cluster", "hyperflex.ClusterBackupPolicy", "hyperflex.ClusterBackupPolicyDeployment", "hyperflex.ClusterBackupPolicyInventory", "hyperflex.ClusterHealthCheckExecutionSnapshot", "hyperflex.ClusterNetworkPolicy", "hyperflex.ClusterProfile", "hyperflex.ClusterReplicationNetworkPolicy", "hyperflex.ClusterReplicationNetworkPolicyDeployment", "hyperflex.ClusterStoragePolicy", "hyperflex.ConfigResult", "hyperflex.ConfigResultEntry", "hyperflex.DataProtectionPeer", "hyperflex.DatastoreStatistic", "hyperflex.DevicePackageDownloadState", "hyperflex.Drive", "hyperflex.Encryption", "hyperflex.ExtFcStoragePolicy", "hyperflex.ExtIscsiStoragePolicy", "hyperflex.FeatureLimitExternal", "hyperflex.FeatureLimitInternal", "hyperflex.Health", "hyperflex.HealthCheckDefinition", "hyperflex.HealthCheckExecution", "hyperflex.HealthCheckExecutionSnapshot", "hyperflex.HealthCheckPackageChecksum", "hyperflex.HealthCheckSchedulePolicy", "hyperflex.HwCatalog", "hyperflex.HxdpVersion", "hyperflex.HypervisorHost", "hyperflex.HypervisorVirtualMachine", "hyperflex.InitiatorGroup", "hyperflex.IscsiNetwork", "hyperflex.KeyEncryptionKey", "hyperflex.License", "hyperflex.LocalCredentialPolicy", "hyperflex.Lun", "hyperflex.Node", "hyperflex.NodeConfigPolicy", "hyperflex.NodeProfile", "hyperflex.ProtectedCluster", "hyperflex.ProxySettingPolicy", "hyperflex.ReduceReSync", "hyperflex.ServerFirmwareVersion", "hyperflex.ServerFirmwareVersionEntry", "hyperflex.ServerModel", "hyperflex.ServiceAuthToken", "hyperflex.SoftwareDistributionComponent", "hyperflex.SoftwareDistributionEntry", "hyperflex.SoftwareDistributionVersion", "hyperflex.SoftwareVersionPolicy", "hyperflex.StartReduceReSync", "hyperflex.StorageContainer", "hyperflex.SysConfigPolicy", "hyperflex.Target", "hyperflex.UcsmConfigPolicy", "hyperflex.VcenterConfigPolicy", "hyperflex.VmBackupInfo", "hyperflex.VmImportOperation", "hyperflex.VmRestoreOperation", "hyperflex.VmSnapshotInfo", "hyperflex.Volume", "hyperflex.WitnessConfiguration", "iaas.ConnectorPack", "iaas.CustomTaskInfo", "iaas.DeviceStatus", "iaas.DiagnosticMessages", "iaas.LicenseInfo", "iaas.MostRunTasks", "iaas.ServiceRequest", "iaas.SystemTaskInfo", "iaas.UcsdInfo", "iaas.UcsdManagedInfra", "iaas.UcsdMessages", "iam.Account", "iam.AccountExperience", "iam.ApiKey", "iam.AppRegistration", "iam.BannerMessage", "iam.Certificate", "iam.CertificateRequest", "iam.CuiIntegration", "iam.DefaultAuthentication", "iam.DomainGroup", "iam.DomainNameInfo", "iam.EndPointPrivilege", "iam.EndPointRole", "iam.EndPointUser", "iam.EndPointUserInventory", "iam.EndPointUserPolicy", "iam.EndPointUserPolicyInventory", "iam.EndPointUserRole", "iam.EndPointUserRoleInventory", "iam.GuestAccessSettings", "iam.Idp", "iam.IdpReference", "iam.IpAccessManagement", "iam.IpAddress", "iam.LdapConfigParams", "iam.LdapGroup", "iam.LdapGroupInventory", "iam.LdapMeta", "iam.LdapPolicy", "iam.LdapPolicyInventory", "iam.LdapProvider", "iam.LdapProviderInventory", "iam.LocalUserPassword", "iam.LocalUserPasswordPolicy", "iam.OAuthToken", "iam.PasswordHistorySettingCollection", "iam.Permission", "iam.PrivateKeySpec", "iam.Privilege", "iam.PrivilegeSet", "iam.PrivilegeSetMetaInfo", "iam.Qualifier", "iam.ResourceLimits", "iam.ResourcePermission", "iam.ResourceRoles", "iam.Role", "iam.SecurityHolder", "iam.ServiceProvider", "iam.Session", "iam.SessionLimits", "iam.SharingRule", "iam.System", "iam.TestIdpConfiguration", "iam.TrustPoint", "iam.User", "iam.UserGroup", "iam.UserPreference", "iam.UserQualifier", "iam.UserSetting", "inventory.DeviceInfo", "inventory.DnMoBinding", "inventory.GenericInventory", "inventory.GenericInventoryHolder", "inventory.Request", "ipmioverlan.Policy", "ipmioverlan.PolicyInventory", "ippool.BlockLease", "ippool.IpLease", "ippool.Pool", "ippool.PoolMember", "ippool.Reservation", "ippool.ShadowBlock", "ippool.ShadowPool", "ippool.Universe", "iqnpool.Block", "iqnpool.Lease", "iqnpool.Pool", "iqnpool.PoolMember", "iqnpool.Reservation", "iqnpool.Universe", "iwotenant.MaintenanceNotification", "iwotenant.Migrate", "iwotenant.TenantCustomization", "iwotenant.TenantStatus", "kvm.Policy", "kvm.PolicyInventory", "kvm.Session", "kvm.Tunnel", "kvm.TunneledKvmPolicy", "license.AccountLicenseData", "license.CustomerOp", "license.ErpCustomerOp", "license.ErpLicenseCount", "license.IksCustomerOp", "license.IksLicenseCount", "license.IncCustomerOp", "license.IncLicenseCount", "license.IwoCustomerOp", "license.IwoLicenseCount", "license.LicenseInfo", "license.LicenseInfoView", "license.LicenseRegistrationStatus", "license.LicenseReservationOp", "license.SmartlicenseToken", "ls.ServiceProfile", "macpool.IdBlock", "macpool.Lease", "macpool.Pool", "macpool.PoolMember", "macpool.Reservation", "macpool.Universe", "management.Controller", "management.Entity", "management.Interface", "memory.Array", "memory.PersistentMemoryConfigResult", "memory.PersistentMemoryConfiguration", "memory.PersistentMemoryNamespace", "memory.PersistentMemoryNamespaceConfigResult", "memory.PersistentMemoryPolicy", "memory.PersistentMemoryRegion", "memory.PersistentMemoryUnit", "memory.Policy", "memory.PolicyInventory", "memory.Unit", "meraki.Device", "meraki.Network", "meraki.Organization", "meraki.PortProfile", "meraki.Tag", "meta.Definition", "metrics.Configuration", "metrics.MetricsExploration", "metrics.ResourceConfiguration", "mgmt.BackupCategory", "mgmt.ConfigBackupFile", "mgmt.ConfigBackupInstance", "mgmt.ConfigBackupOperation", "mgmt.ConfigCategorySummary", "mgmt.ConfigOperationSetting", "mgmt.ConfigRestoreCategorySummary", "mgmt.ConfigRestoreOperation", "mgmt.ObjectBackupMeta", "mgmt.OrgBackupOperation", "mgmt.OrgRestoreOperation", "monitoring.HealthStatus", "network.DiscoveredNeighbor", "network.Dns", "network.Element", "network.ElementSummary", "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", "networkconfig.Policy", "networkconfig.PolicyInventory", "niaapi.ApicCcoPost", "niaapi.ApicFieldNotice", "niaapi.ApicHweol", "niaapi.ApicLatestMaintainedRelease", "niaapi.ApicReleaseRecommend", "niaapi.ApicSweol", "niaapi.DcnmCcoPost", "niaapi.DcnmFieldNotice", "niaapi.DcnmHweol", "niaapi.DcnmLatestMaintainedRelease", "niaapi.DcnmReleaseRecommend", "niaapi.DcnmSweol", "niaapi.FileDownloader", "niaapi.NdEncryptedFileDownload", "niaapi.NdMetadata", "niaapi.NdMetadataFileDownloader", "niaapi.NdMetadataSoftwareDownload", "niaapi.NiaMetadata", "niaapi.NibFileDownloader", "niaapi.NibMetadata", "niaapi.PuvScriptDownloader", "niaapi.SnValidatorMetadata", "niaapi.UpgradeAssistFile", "niaapi.VersionRegex", "niatelemetry.AaaLdapProviderDetails", "niatelemetry.AaaRadiusProviderDetails", "niatelemetry.AaaTacacsProviderDetails", "niatelemetry.Anomaly", "niatelemetry.ApicAppPluginDetails", "niatelemetry.ApicCoreFileDetails", "niatelemetry.ApicDbgexpRsExportDest", "niatelemetry.ApicDbgexpRsTsScheduler", "niatelemetry.ApicFanDetails", "niatelemetry.ApicFexDetails", "niatelemetry.ApicFlashDetails", "niatelemetry.ApicNtpAuth", "niatelemetry.ApicPerformanceData", "niatelemetry.ApicPodData", "niatelemetry.ApicPsuDetails", "niatelemetry.ApicRealmDetails", "niatelemetry.ApicSnmpClientGrpDetails", "niatelemetry.ApicSnmpCommunityAccessDetails", "niatelemetry.ApicSnmpCommunityDetails", "niatelemetry.ApicSnmpTrapDetails", "niatelemetry.ApicSnmpTrapFwdServerDetails", "niatelemetry.ApicSnmpVersionThreeDetails", "niatelemetry.ApicSysLogGrp", "niatelemetry.ApicSysLogSrc", "niatelemetry.ApicTransceiverDetails", "niatelemetry.ApicUiPageCounts", "niatelemetry.ApicVision", "niatelemetry.AppDetails", "niatelemetry.CloudDetails", "niatelemetry.Cluster", "niatelemetry.ClusterNode", "niatelemetry.CommonPolicies", "niatelemetry.Controller", "niatelemetry.DcnmFanDetails", "niatelemetry.DcnmFexDetails", "niatelemetry.DcnmModuleDetails", "niatelemetry.DcnmPsuDetails", "niatelemetry.DcnmTransceiverDetails", "niatelemetry.DomInfoObject", "niatelemetry.DomThresInfoObject", "niatelemetry.Epg", "niatelemetry.Fabric", "niatelemetry.FabricModuleDetails", "niatelemetry.FabricNodeControlDetails", "niatelemetry.FabricPodProfile", "niatelemetry.FabricPodSs", "niatelemetry.Fault", "niatelemetry.HcloudDetails", "niatelemetry.HealthInsightsData", "niatelemetry.HttpsAclContractDetails", "niatelemetry.HttpsAclContractFilterMap", "niatelemetry.HttpsAclEpgContractMap", "niatelemetry.HttpsAclEpgDetails", "niatelemetry.HttpsAclFilterDetails", "niatelemetry.InsightGroupDetails", "niatelemetry.Lc", "niatelemetry.LeafPolGrpDetails", "niatelemetry.Link", "niatelemetry.MdsNeighbors", "niatelemetry.MsoContractDetails", "niatelemetry.MsoEpgDetails", "niatelemetry.MsoSchemaDetails", "niatelemetry.MsoSiteDetails", "niatelemetry.MsoTenantDetails", "niatelemetry.Neighbor", "niatelemetry.Network", "niatelemetry.NexusCloudAccount", "niatelemetry.NexusCloudSite", "niatelemetry.NexusDashboardControllerDetails", "niatelemetry.NexusDashboardDetails", "niatelemetry.NexusDashboardMemoryDetails", "niatelemetry.NexusDashboards", "niatelemetry.NiaFeatureUsage", "niatelemetry.NiaInventory", "niatelemetry.NiaInventoryDcnm", "niatelemetry.NiaInventoryFabric", "niatelemetry.NiaLicenseState", "niatelemetry.Nicc", "niatelemetry.PasswordStrengthCheck", "niatelemetry.PodCommPolicies", "niatelemetry.PodSnmpPolicies", "niatelemetry.PodTimeServerPolicies", "niatelemetry.Route", "niatelemetry.SiteInventory", "niatelemetry.SnmpSrc", "niatelemetry.SpinePolGrpDetails", "niatelemetry.SshVersionTwo", "niatelemetry.SupervisorModuleDetails", "niatelemetry.Switch", "niatelemetry.SwitchInterface", "niatelemetry.SyslogRemoteDest", "niatelemetry.SyslogSysMsg", "niatelemetry.SyslogSysMsgFacFilter", "niatelemetry.SystemControllerDetails", "niatelemetry.Tenant", "notification.AccountSubscription", "ntp.NtpServer", "ntp.Policy", "ntp.PolicyInventory", "oauth.AccessToken", "oauth.Authorization", "onprem.ApplianceSystemInfo", "onprem.AuditRecord", "onprem.Upgrade", "onprem.UserPreference", "openapi.ApiMethodMeta", "openapi.OpenApiSpecification", "openapi.ProcessFile", "openapi.TaskGenerationRequest", "openapi.TaskGenerationResult", "oprs.Deployment", "oprs.SyncTargetListMessage", "organization.Organization", "os.BulkInstallInfo", "os.Catalog", "os.ConfigurationFile", "os.Distribution", "os.Install", "os.OsSupport", "os.SupportedVersion", "os.TemplateFile", "os.ValidInstallTarget", "os.ValidRemoteTarget", "partnerintegration.DcLogs", "partnerintegration.DeviceConnector", "partnerintegration.DocIssues", "partnerintegration.Etl", "partnerintegration.File", "partnerintegration.Inventory", "partnerintegration.Logs", "partnerintegration.Metrics", "partnerintegration.Model", "pci.CoprocessorCard", "pci.Device", "pci.Endpoint", "pci.Link", "pci.Node", "pci.NodeSetting", "pci.Port", "pci.Slot", "pci.Switch", "pci.Zone", "pool.IdMappingMember", "pool.IdMappingPolicy", "port.Group", "port.MacBinding", "port.SubGroup", "power.ControlState", "power.Policy", "power.PolicyInventory", "power.PowerGroup", "power.PowerGroupMember", "processor.Unit", "rack.UnitPersonality", "recommendation.CapacityRunway", "recommendation.ClusterExpansion", "recommendation.HardwareExpansionRequest", "recommendation.HardwareExpansionRequestItem", "recommendation.PhysicalItem", "recommendation.PurchaseOrderEstimate", "recommendation.PurchaseOrderList", "recommendation.SoftwareItem", "recovery.BackupConfigPolicy", "recovery.BackupProfile", "recovery.ConfigResult", "recovery.ConfigResultEntry", "recovery.OnDemandBackup", "recovery.Restore", "recovery.ScheduleConfigPolicy", "resource.Group", "resource.GroupMember", "resource.LicenseResourceCount", "resource.Membership", "resource.MembershipHolder", "resource.Reservation", "resource.SelectionCriteria", "resource.SharedResourcesInfoHolder", "resourcepool.ChassisQualificationPolicy", "resourcepool.Lease", "resourcepool.LeaseResource", "resourcepool.MembershipReservation", "resourcepool.Pool", "resourcepool.PoolMember", "resourcepool.QualificationPolicy", "resourcepool.Reservation", "resourcepool.Universe", "rproxy.ReverseProxy", "scheduler.SchedulePolicy", "scheduler.TaskResult", "scheduler.TaskSchedule", "sdaaci.Connection", "sdaaci.ConnectionDetail", "sdcard.Policy", "sdcard.PolicyInventory", "search.SearchItem", "search.TagItem", "security.Unit", "server.ConfigChangeDetail", "server.ConfigImport", "server.ConfigResult", "server.ConfigResultEntry", "server.DiagnosticStatus", "server.Diagnostics", "server.Disruption", "server.MigrationKeyDetails", "server.Profile", "server.ProfilePendingChangeEval", "server.ProfileTemplate", "servicenow.ChangeRequest", "servicenow.ChangeRequestDoc", "servicenow.Incident", "servicenow.IncidentDoc", "smtp.Policy", "smtp.PolicyInventory", "smtp.PolicyTest", "snmp.Policy", "snmp.PolicyInventory", "software.ApplianceDistributable", "software.DownloadHistory", "software.HciBundleDistributable", "software.HciDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.IksBundleDistributable", "software.ReleaseMeta", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable", "softwarerepository.Authorization", "softwarerepository.CachedImage", "softwarerepository.Catalog", "softwarerepository.CategoryMapper", "softwarerepository.CategoryMapperModel", "softwarerepository.CategorySupportConstraint", "softwarerepository.CategoryUnsupportedModels", "softwarerepository.DownloadSpec", "softwarerepository.OperatingSystemFile", "softwarerepository.Release", "sol.Policy", "sol.PolicyInventory", "ssh.Policy", "ssh.PolicyInventory", "storage.BatteryBackupUnit", "storage.Controller", "storage.ControllerDrive", "storage.DiskGroup", "storage.DiskSlot", "storage.DriveGroup", "storage.DriveSecurityPolicy", "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.HitachiExternalParityGroup", "storage.HitachiExternalPathGroup", "storage.HitachiExternalStorageLun", "storage.HitachiExternalStoragePort", "storage.HitachiHost", "storage.HitachiHostLun", "storage.HitachiNvmSubsystem", "storage.HitachiParityGroup", "storage.HitachiPool", "storage.HitachiPort", "storage.HitachiRemoteCopyPairGad", "storage.HitachiRemoteCopyPairTc", "storage.HitachiRemoteCopyPairUr", "storage.HitachiRemoteReplication", "storage.HitachiSnapshot", "storage.HitachiVolume", "storage.HitachiVolumeMigrationPair", "storage.HyperFlexStorageContainer", "storage.HyperFlexVolume", "storage.Item", "storage.KnoxSecureDriveConfiguration", "storage.NetAppAggregate", "storage.NetAppAggregateEvent", "storage.NetAppBaseDisk", "storage.NetAppCifsService", "storage.NetAppCifsShare", "storage.NetAppCloudTarget", "storage.NetAppCluster", "storage.NetAppClusterEvent", "storage.NetAppClusterSnapMirrorPolicy", "storage.NetAppClusterSnapshotPolicy", "storage.NetAppDataIpInterface", "storage.NetAppDataIpInterfaceEvent", "storage.NetAppDiskEvent", "storage.NetAppEthernetPort", "storage.NetAppEthernetPortEvent", "storage.NetAppExportPolicy", "storage.NetAppFcInterface", "storage.NetAppFcInterfaceEvent", "storage.NetAppFcPort", "storage.NetAppFcPortEvent", "storage.NetAppInitiatorGroup", "storage.NetAppIpInterface", "storage.NetAppIpInterfaceEvent", "storage.NetAppIscsiService", "storage.NetAppLicense", "storage.NetAppLun", "storage.NetAppLunEvent", "storage.NetAppLunMap", "storage.NetAppNamespace", "storage.NetAppNfsClient", "storage.NetAppNfsService", "storage.NetAppNode", "storage.NetAppNodeCdpNeighbor", "storage.NetAppNodeEvent", "storage.NetAppNonDataIpInterface", "storage.NetAppNonDataIpInterfaceEvent", "storage.NetAppNtpServer", "storage.NetAppQtree", "storage.NetAppSchedule", "storage.NetAppSensor", "storage.NetAppSnapMirrorRelationship", "storage.NetAppStorageVm", "storage.NetAppSvmEvent", "storage.NetAppSvmSnapMirrorPolicy", "storage.NetAppSvmSnapshotPolicy", "storage.NetAppVolume", "storage.NetAppVolumeEvent", "storage.NetAppVolumeSnapshot", "storage.NvmeRaidConfiguration", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PhysicalDiskUsage", "storage.PureArray", "storage.PureArrayAlerts", "storage.PureBlade", "storage.PureController", "storage.PureDirectory", "storage.PureDirectoryExport", "storage.PureDirectoryPolicy", "storage.PureDirectoryQuota", "storage.PureDirectorySnapshot", "storage.PureDisk", "storage.PureFileSystems", "storage.PureFlashBladeFileSystem", "storage.PureFlashBladeSystem", "storage.PureHost", "storage.PureHostGroup", "storage.PureHostLun", "storage.PureManagementAccessPolicy", "storage.PureNfsPolicyRule", "storage.PureObjectBucket", "storage.PureObjectStoreAccount", "storage.PureObjectStoreUser", "storage.PurePod", "storage.PurePort", "storage.PureProtectionGroup", "storage.PureProtectionGroupSnapshot", "storage.PureQuotaPolicyRule", "storage.PureRealm", "storage.PureReplicationSchedule", "storage.PureSmbPolicyRule", "storage.PureSnapshotSchedule", "storage.PureTargetArray", "storage.PureVolume", "storage.PureVolumeGroup", "storage.PureVolumeSnapshot", "storage.SasExpander", "storage.SasPort", "storage.Span", "storage.StoragePolicy", "storage.VdMemberEp", "storage.VirtualDrive", "storage.VirtualDriveContainer", "storage.VirtualDriveExtension", "storage.VirtualDriveIdentity", "syslog.Policy", "syslog.PolicyInventory", "tam.AdvisoryCount", "tam.AdvisoryDefinition", "tam.AdvisoryInfo", "tam.AdvisoryInstance", "tam.SecurityAdvisory", "task.CatalystSdwanScopedInventory", "task.FabricMosScopedInventory", "task.HciScopedInventory", "task.HitachiScopedInventory", "task.HyperFlexManagementScopedInventory", "task.HyperflexScopedInventory", "task.MdsScopedInventory", "task.MdsSystemScopedInventory", "task.MerakiScopedInventory", "task.NetAppScopedInventory", "task.NexusScopedInventory", "task.NexusSystemScopedInventory", "task.NexusVlanScopedInventory", "task.PureFlashBladeScopedInventory", "task.PureScopedInventory", "task.ServerScopedInventory", "techsupportmanagement.CollectionControlPolicy", "techsupportmanagement.Download", "techsupportmanagement.EndPoint", "techsupportmanagement.TechSupportBundle", "techsupportmanagement.TechSupportStatus", "terminal.AuditLog", "thermal.Policy", "thermal.PolicyInventory", "top.System", "ucsd.BackupInfo", "uuidpool.Block", "uuidpool.Pool", "uuidpool.PoolMember", "uuidpool.Reservation", "uuidpool.Universe", "uuidpool.UuidLease", "view.HealthStatus", "view.Server", "virtualization.EsxiConsole", "virtualization.Host", "virtualization.VirtualMachine", "virtualization.VmwareCluster", "virtualization.VmwareDatacenter", "virtualization.VmwareDatastore", "virtualization.VmwareDatastoreCluster", "virtualization.VmwareDistributedNetwork", "virtualization.VmwareDistributedSwitch", "virtualization.VmwareFolder", "virtualization.VmwareHost", "virtualization.VmwareHostGpu", "virtualization.VmwareKernelNetwork", "virtualization.VmwareNetwork", "virtualization.VmwarePhysicalNetworkInterface", "virtualization.VmwareProactiveHa", "virtualization.VmwareUplinkPort", "virtualization.VmwareVcenter", "virtualization.VmwareVirtualDisk", "virtualization.VmwareVirtualMachine", "virtualization.VmwareVirtualMachineGpu", "virtualization.VmwareVirtualMachineSnapshot", "virtualization.VmwareVirtualNetworkInterface", "virtualization.VmwareVirtualSwitch", "vmedia.Policy", "vmedia.PolicyInventory", "vmrc.Console", "vnic.EthAdapterPolicy", "vnic.EthAdapterPolicyInventory", "vnic.EthIf", "vnic.EthIfInventory", "vnic.EthNetworkPolicy", "vnic.EthNetworkPolicyInventory", "vnic.EthQosPolicy", "vnic.EthQosPolicyInventory", "vnic.EthVethInventory", "vnic.EthVnicInventory", "vnic.FcAdapterPolicy", "vnic.FcAdapterPolicyInventory", "vnic.FcIf", "vnic.FcIfInventory", "vnic.FcNetworkPolicy", "vnic.FcNetworkPolicyInventory", "vnic.FcQosPolicy", "vnic.FcQosPolicyInventory", "vnic.FcVethInventory", "vnic.FcVhbaPolicyInventory", "vnic.IscsiAdapterPolicy", "vnic.IscsiAdapterPolicyInventory", "vnic.IscsiBootPolicy", "vnic.IscsiBootPolicyInventory", "vnic.IscsiStaticTargetPolicy", "vnic.IscsiStaticTargetPolicyInventory", "vnic.LanConnectivityPolicy", "vnic.LanConnectivityPolicyInventory", "vnic.LanSettings", "vnic.LcpStatus", "vnic.SanConnectivityPolicy", "vnic.SanConnectivityPolicyInventory", "vnic.SanSettings", "vnic.ScpStatus", "vnic.ServiceEthIf", "vnic.ServiceEthIfInventory", "vnic.VhbaTemplate", "vnic.VifIdPool", "vnic.VnicTemplate", "vrf.Vrf", "webhook.Endpoint", "webhook.Schema", "workflow.AnsibleBatchExecutor", "workflow.BatchApiExecutor", "workflow.Catalog", "workflow.CatalogItemDefinition", "workflow.CatalogServiceRequest", "workflow.CustomDataTypeDefinition", "workflow.ErrorResponseHandler", "workflow.PowerShellBatchApiExecutor", "workflow.RollbackWorkflow", "workflow.ServiceItemActionDefinition", "workflow.ServiceItemActionInstance", "workflow.ServiceItemAttribute", "workflow.ServiceItemDefinition", "workflow.ServiceItemHealthCheckDefinition", "workflow.ServiceItemHealthCheckExecution", "workflow.ServiceItemInstance", "workflow.ServiceItemOutput", "workflow.SshBatchExecutor", "workflow.TaskDebugLog", "workflow.TaskDefinition", "workflow.TaskInfo", "workflow.TaskMetadata", "workflow.TemplateEvaluation", "workflow.TemplateFunctionMeta", "workflow.TemplateParser", "workflow.UiDisplayMetadata", "workflow.Variable", "workflow.WorkflowDefinition", "workflow.WorkflowInfo", "workflow.WorkflowMetadata", "workload.Blueprint", "workload.ClearWorkloadTag", "workload.DeploymentInput", "workload.WorkloadDefinition", "workload.WorkloadDeployment", "workload.WorkloadInstance", "workload.WorkloadMetadata" ], "x-enum-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.", "type": "string", "enum": [ "aaa.AuditRecord", "aaa.RetentionConfig", "aaa.RetentionPolicy", "access.IpAddress", "access.Policy", "access.PolicyInventory", "adapter.ConfigPolicy", "adapter.ExtEthInterface", "adapter.HostEthInterface", "adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "apic.AciPod", "apic.Application", "apic.ApplicationEndpointGroup", "apic.BridgeDomain", "apic.ExternalRoutedLayerThreeDomain", "apic.FabricLeafNode", "apic.FabricLeafNodeInterface", "apic.Out", "apic.Subnet", "apic.Tenant", "apic.VpcGroup", "apic.Vrfs", "apiproxy.AllowList", "appliance.AppOpStatus", "appliance.AppStatus", "appliance.AutoRmaPolicy", "appliance.Backup", "appliance.BackupDownload", "appliance.BackupMonitor", "appliance.BackupPolicy", "appliance.BackupRotateData", "appliance.CertificateSetting", "appliance.ClusterInfo", "appliance.ClusterInstall", "appliance.ClusterReplaceNode", "appliance.ClusterWorkerNode", "appliance.ClusterWorkerNodeReplace", "appliance.ClusterWorkerNodeReuse", "appliance.CpuUtilization", "appliance.DataExportPolicy", "appliance.DeviceCertificate", "appliance.DeviceClaim", "appliance.DeviceClusterInstall", "appliance.DeviceState", "appliance.DeviceUpgradePolicy", "appliance.DiagSetting", "appliance.ExternalSyslogSetting", "appliance.FileGateway", "appliance.FileSystemOpStatus", "appliance.FileSystemOpSummary", "appliance.FileSystemStatus", "appliance.FileSystemTelemetry", "appliance.FqdnUpdate", "appliance.GroupOpStatus", "appliance.GroupStatus", "appliance.ImageBundle", "appliance.MemoryUtilization", "appliance.MetaManifest", "appliance.MetricsConfig", "appliance.MetricsIngestionUtilization", "appliance.NetworkLinkStatus", "appliance.NodeInfo", "appliance.NodeIopsMetric", "appliance.NodeOpStatus", "appliance.NodeStatus", "appliance.NodeTelemetry", "appliance.ReleaseNote", "appliance.RemoteFileImport", "appliance.Restore", "appliance.SetupInfo", "appliance.SystemInfo", "appliance.SystemOpStatus", "appliance.SystemStatus", "appliance.Upgrade", "appliance.UpgradePolicy", "appliance.UpgradeTracker", "asset.ClaimToken", "asset.ClusterMember", "asset.Deployment", "asset.DeploymentDevice", "asset.DeviceClaim", "asset.DeviceConfiguration", "asset.DeviceConnectorManager", "asset.DeviceContractInformation", "asset.DeviceContractNotification", "asset.DeviceRegistration", "asset.GeoLocation", "asset.PreClaim", "asset.Subscription", "asset.SubscriptionAccount", "asset.SubscriptionDeviceContractInformation", "asset.Target", "auditd.Policy", "bios.BootDevice", "bios.BootMode", "bios.Policy", "bios.SystemBootOrder", "bios.TokenSettings", "bios.Unit", "bios.VfSelectMemoryRasConfiguration", "boot.CddDevice", "boot.DeviceBootMode", "boot.DeviceBootSecurity", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PrecisionPolicy", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "bulk.Export", "bulk.ExportedItem", "bulk.MoCloner", "bulk.MoDeepCloner", "bulk.MoMerger", "bulk.Request", "bulk.Result", "bulk.SubRequestObj", "capability.ActionsMetaData", "capability.AdapterDeprecatedDef", "capability.AdapterFirmwareRequirement", "capability.AdapterUnitDescriptor", "capability.AdapterUpdateConstraintMeta", "capability.AdapterUpgradeSupportMeta", "capability.BiosTokens", "capability.Catalog", "capability.ChassisDescriptor", "capability.ChassisManufacturingDef", "capability.ChassisUpgradeSupportMeta", "capability.CimcFirmwareDescriptor", "capability.CpuEndpointDescriptor", "capability.DimmsEndpointDescriptor", "capability.DomainPolicyRequirement", "capability.DrivesEndpointDescriptor", "capability.EquipmentPhysicalDef", "capability.EquipmentSlotArray", "capability.FanModuleDescriptor", "capability.FanModuleManufacturingDef", "capability.FexCapabilityDef", "capability.FexDescriptor", "capability.FexManufacturingDef", "capability.FexSupportMeta", "capability.GpuEndpointDescriptor", "capability.HsuIsoFileSupportMeta", "capability.IoCardCapabilityDef", "capability.IoCardDescriptor", "capability.IoCardManufacturingDef", "capability.IomUpgradeSupportMeta", "capability.NetworkEquipmentPowerDef", "capability.PolicyConstants", "capability.PortGroupAggregationDef", "capability.ProcessorUnitUpdateConstraintMeta", "capability.PsuDescriptor", "capability.PsuManufacturingDef", "capability.ServerActionsMeta", "capability.ServerDescriptor", "capability.ServerModelsCapabilityDef", "capability.ServerPcieConnectivityCatalog", "capability.ServerSchemaDescriptor", "capability.ServerTopologyMap", "capability.ServerUpgradeSupportMeta", "capability.SiocModuleCapabilityDef", "capability.SiocModuleDescriptor", "capability.SiocModuleManufacturingDef", "capability.StandardRedfishSupportMeta", "capability.StorageControllerUpdateConstraintMeta", "capability.StorageControllersMetaData", "capability.SwitchCapability", "capability.SwitchDescriptor", "capability.SwitchEquipmentInfo", "capability.SwitchManufacturingDef", "capability.SwitchUpgradeSupportMeta", "capability.TemplateCatalog", "capability.TimeZoneMetaData", "capability.UpdateOrderMeta", "capability.VicDescriptor", "catalystsdwan.ConfigGroup", "catalystsdwan.Interface", "catalystsdwan.PhysicalPort", "catalystsdwan.PolicyGroup", "catalystsdwan.PortChannel", "catalystsdwan.VedgeDevice", "catalystsdwan.Vlan", "catalystsdwan.WanEdgeDevice", "certificatemanagement.Policy", "certificatemanagement.PolicyInventory", "chassis.ConfigChangeDetail", "chassis.ConfigImport", "chassis.ConfigResult", "chassis.ConfigResultEntry", "chassis.IomProfile", "chassis.Profile", "chassis.ProfileTemplate", "cli.CliPolicy", "cloud.CollectInventory", "cloud.TfcAgentpool", "cloud.TfcOrganization", "cloud.TfcWorkspace", "comm.HttpProxyPolicy", "comm.TagDefinition", "compute.Blade", "compute.BladeIdentity", "compute.Board", "compute.DownloadStatus", "compute.HostUtilityOperation", "compute.Mapping", "compute.PcieConnectivityPolicy", "compute.PcieConnectivityPolicyInventory", "compute.Personality", "compute.PhysicalSummary", "compute.RackUnit", "compute.RackUnitIdentity", "compute.ScrubPolicy", "compute.ServerIdPool", "compute.ServerPowerParameters", "compute.ServerPowerPolicy", "compute.ServerSetting", "compute.Vmedia", "cond.Alarm", "cond.AlarmAggregation", "cond.AlarmClassification", "cond.AlarmDefinition", "cond.AlarmRule", "cond.AlarmSuppression", "cond.AlarmSuppressionDryRun", "cond.CustomHclBaseline", "cond.CustomHclStatus", "cond.HclStatus", "cond.HclStatusDetail", "cond.HclStatusJob", "cond.ThresholdDefinition", "connectorpack.ConnectorPackUpgrade", "connectorpack.UpgradeImpact", "console.ConsoleConfig", "convergedinfra.AdapterComplianceDetails", "convergedinfra.Pod", "convergedinfra.PodComplianceInfo", "convergedinfra.ServerComplianceDetails", "convergedinfra.StorageComplianceDetails", "convergedinfra.SwitchComplianceDetails", "coremanagement.CoreFile", "coremanagement.Download", "crd.CustomResource", "deviceconnector.Policy", "dnac.Device", "dnac.DeviceInterface", "dnac.ExternalBorderNode", "dnac.ExternalBorderNodeInterface", "dnac.FabricSite", "dnac.Site", "dnac.SiteIpPool", "dnac.Template", "dnac.Transit", "dnac.VirtualNetworkFabricSite", "energy.DailyMetrics", "energy.Metrics", "equipment.Chassis", "equipment.ChassisController", "equipment.ChassisIdPool", "equipment.ChassisIdentity", "equipment.ChassisOperation", "equipment.DeviceSummary", "equipment.EnclosureElement", "equipment.EndPointLog", "equipment.ExpanderModule", "equipment.ExpanderModuleIdentity", "equipment.ExpanderModuleOperation", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.FexIdentity", "equipment.FexOperation", "equipment.Fru", "equipment.HybridDriveSlot", "equipment.Interconnect", "equipment.IoCard", "equipment.IoCardOperation", "equipment.IoExpander", "equipment.LocatorLed", "equipment.LogDownload", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.Riser", "equipment.Sensor", "equipment.SharedAdapterUnit", "equipment.SharedGraphicsCard", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SwitchOperation", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "ether.HostPort", "ether.InterSwitchPort", "ether.LanPort", "ether.NetworkPort", "ether.PhysicalPort", "ether.PortChannel", "externalsite.Authorization", "fabric.AppliancePcRole", "fabric.ApplianceRole", "fabric.ConfigChangeDetail", "fabric.ConfigResult", "fabric.ConfigResultEntry", "fabric.ElementIdentity", "fabric.EstimateImpact", "fabric.EthNetworkControlPolicy", "fabric.EthNetworkControlPolicyInventory", "fabric.EthNetworkGroupPolicy", "fabric.EthNetworkGroupPolicyInventory", "fabric.EthNetworkPolicy", "fabric.FcNetworkPolicy", "fabric.FcStorageRole", "fabric.FcUplinkPcRole", "fabric.FcUplinkRole", "fabric.FcZonePolicy", "fabric.FcoeUplinkPcRole", "fabric.FcoeUplinkRole", "fabric.FlowControlPolicy", "fabric.LanPinGroup", "fabric.LinkAggregationPolicy", "fabric.LinkControlPolicy", "fabric.MacSecPolicy", "fabric.MulticastPolicy", "fabric.NetFlowExporter", "fabric.NetFlowMonitor", "fabric.NetFlowPolicy", "fabric.NetFlowRecord", "fabric.PcMember", "fabric.PcOperation", "fabric.PortMode", "fabric.PortOperation", "fabric.PortPolicy", "fabric.SanPinGroup", "fabric.SecureRouterRole", "fabric.ServerRole", "fabric.SpanDestEthPort", "fabric.SpanSession", "fabric.SpanSourceEthPort", "fabric.SpanSourceEthPortChannel", "fabric.SpanSourceVlan", "fabric.SpanSourceVnicEthIf", "fabric.SwitchClusterProfile", "fabric.SwitchClusterProfileTemplate", "fabric.SwitchControlPolicy", "fabric.SwitchProfile", "fabric.SwitchProfileTemplate", "fabric.SystemQosPolicy", "fabric.UplinkPcRole", "fabric.UplinkRole", "fabric.Vlan", "fabric.VlanInventory", "fabric.VlanSet", "fabric.Vsan", "fabric.VsanInventory", "fault.Instance", "fc.Neighbor", "fc.PhysicalPort", "fc.PortChannel", "fcpool.FcBlock", "fcpool.Lease", "fcpool.Pool", "fcpool.PoolMember", "fcpool.Reservation", "fcpool.Universe", "feedback.FeedbackPost", "firmware.BiosDescriptor", "firmware.BoardControllerDescriptor", "firmware.ChassisUpgrade", "firmware.CimcDescriptor", "firmware.DimmDescriptor", "firmware.Distributable", "firmware.DistributableMeta", "firmware.DriveDescriptor", "firmware.DriverDistributable", "firmware.Eula", "firmware.FirmwareSummary", "firmware.GpuDescriptor", "firmware.HbaDescriptor", "firmware.IomDescriptor", "firmware.MswitchDescriptor", "firmware.NxosDescriptor", "firmware.PciNodeUpgrade", "firmware.PcieDescriptor", "firmware.Policy", "firmware.PsuDescriptor", "firmware.PsxDescriptor", "firmware.RunningFirmware", "firmware.SasExpanderDescriptor", "firmware.SecureRouterUpgrade", "firmware.ServerConfigurationUtilityDistributable", "firmware.StorageControllerDescriptor", "firmware.SwitchUpgrade", "firmware.UnsupportedVersionUpgrade", "firmware.Upgrade", "firmware.UpgradeImpact", "firmware.UpgradeImpactStatus", "firmware.UpgradeStatus", "firmware.UpgradeValidity", "fmc.Device", "fmc.DeviceHaPair", "fmc.Domain", "fmc.PhysicalInterface", "forecast.Catalog", "forecast.Definition", "forecast.Instance", "graphics.Card", "graphics.Controller", "hci.AhvVm", "hci.AhvVmDisk", "hci.AhvVmGpu", "hci.AhvVmNic", "hci.Alarm", "hci.Cluster", "hci.ClusterOperation", "hci.Compliance", "hci.Disk", "hci.DomainManager", "hci.Entitlement", "hci.EsxiVm", "hci.EsxiVmDisk", "hci.EsxiVmNic", "hci.ExternalStorage", "hci.Gpu", "hci.License", "hci.NccCheckPolicy", "hci.Node", "hci.PhysicalGpu", "hci.StorageContainer", "hci.Violation", "hci.VirtualGpu", "hcl.CompatibilityStatus", "hcl.DataImportLog", "hcl.DriverImage", "hcl.ExemptedCatalog", "hcl.HwCatalogInfo", "hcl.HyperflexSoftwareCompatibilityInfo", "hcl.OperatingSystem", "hcl.OperatingSystemVendor", "hcl.ServerCatalog", "hcl.ServerHwCatalogInfo", "hcl.SupportedDriverName", "hyperflex.Alarm", "hyperflex.AppCatalog", "hyperflex.AutoSupportPolicy", "hyperflex.BackupCluster", "hyperflex.CapabilityInfo", "hyperflex.Cluster", "hyperflex.ClusterBackupPolicy", "hyperflex.ClusterBackupPolicyDeployment", "hyperflex.ClusterBackupPolicyInventory", "hyperflex.ClusterHealthCheckExecutionSnapshot", "hyperflex.ClusterNetworkPolicy", "hyperflex.ClusterProfile", "hyperflex.ClusterReplicationNetworkPolicy", "hyperflex.ClusterReplicationNetworkPolicyDeployment", "hyperflex.ClusterStoragePolicy", "hyperflex.ConfigResult", "hyperflex.ConfigResultEntry", "hyperflex.DataProtectionPeer", "hyperflex.DatastoreStatistic", "hyperflex.DevicePackageDownloadState", "hyperflex.Drive", "hyperflex.Encryption", "hyperflex.ExtFcStoragePolicy", "hyperflex.ExtIscsiStoragePolicy", "hyperflex.FeatureLimitExternal", "hyperflex.FeatureLimitInternal", "hyperflex.Health", "hyperflex.HealthCheckDefinition", "hyperflex.HealthCheckExecution", "hyperflex.HealthCheckExecutionSnapshot", "hyperflex.HealthCheckPackageChecksum", "hyperflex.HealthCheckSchedulePolicy", "hyperflex.HwCatalog", "hyperflex.HxdpVersion", "hyperflex.HypervisorHost", "hyperflex.HypervisorVirtualMachine", "hyperflex.InitiatorGroup", "hyperflex.IscsiNetwork", "hyperflex.KeyEncryptionKey", "hyperflex.License", "hyperflex.LocalCredentialPolicy", "hyperflex.Lun", "hyperflex.Node", "hyperflex.NodeConfigPolicy", "hyperflex.NodeProfile", "hyperflex.ProtectedCluster", "hyperflex.ProxySettingPolicy", "hyperflex.ReduceReSync", "hyperflex.ServerFirmwareVersion", "hyperflex.ServerFirmwareVersionEntry", "hyperflex.ServerModel", "hyperflex.ServiceAuthToken", "hyperflex.SoftwareDistributionComponent", "hyperflex.SoftwareDistributionEntry", "hyperflex.SoftwareDistributionVersion", "hyperflex.SoftwareVersionPolicy", "hyperflex.StartReduceReSync", "hyperflex.StorageContainer", "hyperflex.SysConfigPolicy", "hyperflex.Target", "hyperflex.UcsmConfigPolicy", "hyperflex.VcenterConfigPolicy", "hyperflex.VmBackupInfo", "hyperflex.VmImportOperation", "hyperflex.VmRestoreOperation", "hyperflex.VmSnapshotInfo", "hyperflex.Volume", "hyperflex.WitnessConfiguration", "iaas.ConnectorPack", "iaas.CustomTaskInfo", "iaas.DeviceStatus", "iaas.DiagnosticMessages", "iaas.LicenseInfo", "iaas.MostRunTasks", "iaas.ServiceRequest", "iaas.SystemTaskInfo", "iaas.UcsdInfo", "iaas.UcsdManagedInfra", "iaas.UcsdMessages", "iam.Account", "iam.AccountExperience", "iam.ApiKey", "iam.AppRegistration", "iam.BannerMessage", "iam.Certificate", "iam.CertificateRequest", "iam.CuiIntegration", "iam.DefaultAuthentication", "iam.DomainGroup", "iam.DomainNameInfo", "iam.EndPointPrivilege", "iam.EndPointRole", "iam.EndPointUser", "iam.EndPointUserInventory", "iam.EndPointUserPolicy", "iam.EndPointUserPolicyInventory", "iam.EndPointUserRole", "iam.EndPointUserRoleInventory", "iam.GuestAccessSettings", "iam.Idp", "iam.IdpReference", "iam.IpAccessManagement", "iam.IpAddress", "iam.LdapConfigParams", "iam.LdapGroup", "iam.LdapGroupInventory", "iam.LdapMeta", "iam.LdapPolicy", "iam.LdapPolicyInventory", "iam.LdapProvider", "iam.LdapProviderInventory", "iam.LocalUserPassword", "iam.LocalUserPasswordPolicy", "iam.OAuthToken", "iam.PasswordHistorySettingCollection", "iam.Permission", "iam.PrivateKeySpec", "iam.Privilege", "iam.PrivilegeSet", "iam.PrivilegeSetMetaInfo", "iam.Qualifier", "iam.ResourceLimits", "iam.ResourcePermission", "iam.ResourceRoles", "iam.Role", "iam.SecurityHolder", "iam.ServiceProvider", "iam.Session", "iam.SessionLimits", "iam.SharingRule", "iam.System", "iam.TestIdpConfiguration", "iam.TrustPoint", "iam.User", "iam.UserGroup", "iam.UserPreference", "iam.UserQualifier", "iam.UserSetting", "inventory.DeviceInfo", "inventory.DnMoBinding", "inventory.GenericInventory", "inventory.GenericInventoryHolder", "inventory.Request", "ipmioverlan.Policy", "ipmioverlan.PolicyInventory", "ippool.BlockLease", "ippool.IpLease", "ippool.Pool", "ippool.PoolMember", "ippool.Reservation", "ippool.ShadowBlock", "ippool.ShadowPool", "ippool.Universe", "iqnpool.Block", "iqnpool.Lease", "iqnpool.Pool", "iqnpool.PoolMember", "iqnpool.Reservation", "iqnpool.Universe", "iwotenant.MaintenanceNotification", "iwotenant.Migrate", "iwotenant.TenantCustomization", "iwotenant.TenantStatus", "kvm.Policy", "kvm.PolicyInventory", "kvm.Session", "kvm.Tunnel", "kvm.TunneledKvmPolicy", "license.AccountLicenseData", "license.CustomerOp", "license.ErpCustomerOp", "license.ErpLicenseCount", "license.IksCustomerOp", "license.IksLicenseCount", "license.IncCustomerOp", "license.IncLicenseCount", "license.IwoCustomerOp", "license.IwoLicenseCount", "license.LicenseInfo", "license.LicenseInfoView", "license.LicenseRegistrationStatus", "license.LicenseReservationOp", "license.SmartlicenseToken", "ls.ServiceProfile", "macpool.IdBlock", "macpool.Lease", "macpool.Pool", "macpool.PoolMember", "macpool.Reservation", "macpool.Universe", "management.Controller", "management.Entity", "management.Interface", "memory.Array", "memory.PersistentMemoryConfigResult", "memory.PersistentMemoryConfiguration", "memory.PersistentMemoryNamespace", "memory.PersistentMemoryNamespaceConfigResult", "memory.PersistentMemoryPolicy", "memory.PersistentMemoryRegion", "memory.PersistentMemoryUnit", "memory.Policy", "memory.PolicyInventory", "memory.Unit", "meraki.Device", "meraki.Network", "meraki.Organization", "meraki.PortProfile", "meraki.Tag", "meta.Definition", "metrics.Configuration", "metrics.MetricsExploration", "metrics.ResourceConfiguration", "mgmt.BackupCategory", "mgmt.ConfigBackupFile", "mgmt.ConfigBackupInstance", "mgmt.ConfigBackupOperation", "mgmt.ConfigCategorySummary", "mgmt.ConfigOperationSetting", "mgmt.ConfigRestoreCategorySummary", "mgmt.ConfigRestoreOperation", "mgmt.ObjectBackupMeta", "mgmt.OrgBackupOperation", "mgmt.OrgRestoreOperation", "monitoring.HealthStatus", "network.DiscoveredNeighbor", "network.Dns", "network.Element", "network.ElementSummary", "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", "networkconfig.Policy", "networkconfig.PolicyInventory", "niaapi.ApicCcoPost", "niaapi.ApicFieldNotice", "niaapi.ApicHweol", "niaapi.ApicLatestMaintainedRelease", "niaapi.ApicReleaseRecommend", "niaapi.ApicSweol", "niaapi.DcnmCcoPost", "niaapi.DcnmFieldNotice", "niaapi.DcnmHweol", "niaapi.DcnmLatestMaintainedRelease", "niaapi.DcnmReleaseRecommend", "niaapi.DcnmSweol", "niaapi.FileDownloader", "niaapi.NdEncryptedFileDownload", "niaapi.NdMetadata", "niaapi.NdMetadataFileDownloader", "niaapi.NdMetadataSoftwareDownload", "niaapi.NiaMetadata", "niaapi.NibFileDownloader", "niaapi.NibMetadata", "niaapi.PuvScriptDownloader", "niaapi.SnValidatorMetadata", "niaapi.UpgradeAssistFile", "niaapi.VersionRegex", "niatelemetry.AaaLdapProviderDetails", "niatelemetry.AaaRadiusProviderDetails", "niatelemetry.AaaTacacsProviderDetails", "niatelemetry.Anomaly", "niatelemetry.ApicAppPluginDetails", "niatelemetry.ApicCoreFileDetails", "niatelemetry.ApicDbgexpRsExportDest", "niatelemetry.ApicDbgexpRsTsScheduler", "niatelemetry.ApicFanDetails", "niatelemetry.ApicFexDetails", "niatelemetry.ApicFlashDetails", "niatelemetry.ApicNtpAuth", "niatelemetry.ApicPerformanceData", "niatelemetry.ApicPodData", "niatelemetry.ApicPsuDetails", "niatelemetry.ApicRealmDetails", "niatelemetry.ApicSnmpClientGrpDetails", "niatelemetry.ApicSnmpCommunityAccessDetails", "niatelemetry.ApicSnmpCommunityDetails", "niatelemetry.ApicSnmpTrapDetails", "niatelemetry.ApicSnmpTrapFwdServerDetails", "niatelemetry.ApicSnmpVersionThreeDetails", "niatelemetry.ApicSysLogGrp", "niatelemetry.ApicSysLogSrc", "niatelemetry.ApicTransceiverDetails", "niatelemetry.ApicUiPageCounts", "niatelemetry.ApicVision", "niatelemetry.AppDetails", "niatelemetry.CloudDetails", "niatelemetry.Cluster", "niatelemetry.ClusterNode", "niatelemetry.CommonPolicies", "niatelemetry.Controller", "niatelemetry.DcnmFanDetails", "niatelemetry.DcnmFexDetails", "niatelemetry.DcnmModuleDetails", "niatelemetry.DcnmPsuDetails", "niatelemetry.DcnmTransceiverDetails", "niatelemetry.DomInfoObject", "niatelemetry.DomThresInfoObject", "niatelemetry.Epg", "niatelemetry.Fabric", "niatelemetry.FabricModuleDetails", "niatelemetry.FabricNodeControlDetails", "niatelemetry.FabricPodProfile", "niatelemetry.FabricPodSs", "niatelemetry.Fault", "niatelemetry.HcloudDetails", "niatelemetry.HealthInsightsData", "niatelemetry.HttpsAclContractDetails", "niatelemetry.HttpsAclContractFilterMap", "niatelemetry.HttpsAclEpgContractMap", "niatelemetry.HttpsAclEpgDetails", "niatelemetry.HttpsAclFilterDetails", "niatelemetry.InsightGroupDetails", "niatelemetry.Lc", "niatelemetry.LeafPolGrpDetails", "niatelemetry.Link", "niatelemetry.MdsNeighbors", "niatelemetry.MsoContractDetails", "niatelemetry.MsoEpgDetails", "niatelemetry.MsoSchemaDetails", "niatelemetry.MsoSiteDetails", "niatelemetry.MsoTenantDetails", "niatelemetry.Neighbor", "niatelemetry.Network", "niatelemetry.NexusCloudAccount", "niatelemetry.NexusCloudSite", "niatelemetry.NexusDashboardControllerDetails", "niatelemetry.NexusDashboardDetails", "niatelemetry.NexusDashboardMemoryDetails", "niatelemetry.NexusDashboards", "niatelemetry.NiaFeatureUsage", "niatelemetry.NiaInventory", "niatelemetry.NiaInventoryDcnm", "niatelemetry.NiaInventoryFabric", "niatelemetry.NiaLicenseState", "niatelemetry.Nicc", "niatelemetry.PasswordStrengthCheck", "niatelemetry.PodCommPolicies", "niatelemetry.PodSnmpPolicies", "niatelemetry.PodTimeServerPolicies", "niatelemetry.Route", "niatelemetry.SiteInventory", "niatelemetry.SnmpSrc", "niatelemetry.SpinePolGrpDetails", "niatelemetry.SshVersionTwo", "niatelemetry.SupervisorModuleDetails", "niatelemetry.Switch", "niatelemetry.SwitchInterface", "niatelemetry.SyslogRemoteDest", "niatelemetry.SyslogSysMsg", "niatelemetry.SyslogSysMsgFacFilter", "niatelemetry.SystemControllerDetails", "niatelemetry.Tenant", "notification.AccountSubscription", "ntp.NtpServer", "ntp.Policy", "ntp.PolicyInventory", "oauth.AccessToken", "oauth.Authorization", "onprem.ApplianceSystemInfo", "onprem.AuditRecord", "onprem.Upgrade", "onprem.UserPreference", "openapi.ApiMethodMeta", "openapi.OpenApiSpecification", "openapi.ProcessFile", "openapi.TaskGenerationRequest", "openapi.TaskGenerationResult", "oprs.Deployment", "oprs.SyncTargetListMessage", "organization.Organization", "os.BulkInstallInfo", "os.Catalog", "os.ConfigurationFile", "os.Distribution", "os.Install", "os.OsSupport", "os.SupportedVersion", "os.TemplateFile", "os.ValidInstallTarget", "os.ValidRemoteTarget", "partnerintegration.DcLogs", "partnerintegration.DeviceConnector", "partnerintegration.DocIssues", "partnerintegration.Etl", "partnerintegration.File", "partnerintegration.Inventory", "partnerintegration.Logs", "partnerintegration.Metrics", "partnerintegration.Model", "pci.CoprocessorCard", "pci.Device", "pci.Endpoint", "pci.Link", "pci.Node", "pci.NodeSetting", "pci.Port", "pci.Slot", "pci.Switch", "pci.Zone", "pool.IdMappingMember", "pool.IdMappingPolicy", "port.Group", "port.MacBinding", "port.SubGroup", "power.ControlState", "power.Policy", "power.PolicyInventory", "power.PowerGroup", "power.PowerGroupMember", "processor.Unit", "rack.UnitPersonality", "recommendation.CapacityRunway", "recommendation.ClusterExpansion", "recommendation.HardwareExpansionRequest", "recommendation.HardwareExpansionRequestItem", "recommendation.PhysicalItem", "recommendation.PurchaseOrderEstimate", "recommendation.PurchaseOrderList", "recommendation.SoftwareItem", "recovery.BackupConfigPolicy", "recovery.BackupProfile", "recovery.ConfigResult", "recovery.ConfigResultEntry", "recovery.OnDemandBackup", "recovery.Restore", "recovery.ScheduleConfigPolicy", "resource.Group", "resource.GroupMember", "resource.LicenseResourceCount", "resource.Membership", "resource.MembershipHolder", "resource.Reservation", "resource.SelectionCriteria", "resource.SharedResourcesInfoHolder", "resourcepool.ChassisQualificationPolicy", "resourcepool.Lease", "resourcepool.LeaseResource", "resourcepool.MembershipReservation", "resourcepool.Pool", "resourcepool.PoolMember", "resourcepool.QualificationPolicy", "resourcepool.Reservation", "resourcepool.Universe", "rproxy.ReverseProxy", "scheduler.SchedulePolicy", "scheduler.TaskResult", "scheduler.TaskSchedule", "sdaaci.Connection", "sdaaci.ConnectionDetail", "sdcard.Policy", "sdcard.PolicyInventory", "search.SearchItem", "search.TagItem", "security.Unit", "server.ConfigChangeDetail", "server.ConfigImport", "server.ConfigResult", "server.ConfigResultEntry", "server.DiagnosticStatus", "server.Diagnostics", "server.Disruption", "server.MigrationKeyDetails", "server.Profile", "server.ProfilePendingChangeEval", "server.ProfileTemplate", "servicenow.ChangeRequest", "servicenow.ChangeRequestDoc", "servicenow.Incident", "servicenow.IncidentDoc", "smtp.Policy", "smtp.PolicyInventory", "smtp.PolicyTest", "snmp.Policy", "snmp.PolicyInventory", "software.ApplianceDistributable", "software.DownloadHistory", "software.HciBundleDistributable", "software.HciDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.IksBundleDistributable", "software.ReleaseMeta", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable", "softwarerepository.Authorization", "softwarerepository.CachedImage", "softwarerepository.Catalog", "softwarerepository.CategoryMapper", "softwarerepository.CategoryMapperModel", "softwarerepository.CategorySupportConstraint", "softwarerepository.CategoryUnsupportedModels", "softwarerepository.DownloadSpec", "softwarerepository.OperatingSystemFile", "softwarerepository.Release", "sol.Policy", "sol.PolicyInventory", "ssh.Policy", "ssh.PolicyInventory", "storage.BatteryBackupUnit", "storage.Controller", "storage.ControllerDrive", "storage.DiskGroup", "storage.DiskSlot", "storage.DriveGroup", "storage.DriveSecurityPolicy", "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.HitachiExternalParityGroup", "storage.HitachiExternalPathGroup", "storage.HitachiExternalStorageLun", "storage.HitachiExternalStoragePort", "storage.HitachiHost", "storage.HitachiHostLun", "storage.HitachiNvmSubsystem", "storage.HitachiParityGroup", "storage.HitachiPool", "storage.HitachiPort", "storage.HitachiRemoteCopyPairGad", "storage.HitachiRemoteCopyPairTc", "storage.HitachiRemoteCopyPairUr", "storage.HitachiRemoteReplication", "storage.HitachiSnapshot", "storage.HitachiVolume", "storage.HitachiVolumeMigrationPair", "storage.HyperFlexStorageContainer", "storage.HyperFlexVolume", "storage.Item", "storage.KnoxSecureDriveConfiguration", "storage.NetAppAggregate", "storage.NetAppAggregateEvent", "storage.NetAppBaseDisk", "storage.NetAppCifsService", "storage.NetAppCifsShare", "storage.NetAppCloudTarget", "storage.NetAppCluster", "storage.NetAppClusterEvent", "storage.NetAppClusterSnapMirrorPolicy", "storage.NetAppClusterSnapshotPolicy", "storage.NetAppDataIpInterface", "storage.NetAppDataIpInterfaceEvent", "storage.NetAppDiskEvent", "storage.NetAppEthernetPort", "storage.NetAppEthernetPortEvent", "storage.NetAppExportPolicy", "storage.NetAppFcInterface", "storage.NetAppFcInterfaceEvent", "storage.NetAppFcPort", "storage.NetAppFcPortEvent", "storage.NetAppInitiatorGroup", "storage.NetAppIpInterface", "storage.NetAppIpInterfaceEvent", "storage.NetAppIscsiService", "storage.NetAppLicense", "storage.NetAppLun", "storage.NetAppLunEvent", "storage.NetAppLunMap", "storage.NetAppNamespace", "storage.NetAppNfsClient", "storage.NetAppNfsService", "storage.NetAppNode", "storage.NetAppNodeCdpNeighbor", "storage.NetAppNodeEvent", "storage.NetAppNonDataIpInterface", "storage.NetAppNonDataIpInterfaceEvent", "storage.NetAppNtpServer", "storage.NetAppQtree", "storage.NetAppSchedule", "storage.NetAppSensor", "storage.NetAppSnapMirrorRelationship", "storage.NetAppStorageVm", "storage.NetAppSvmEvent", "storage.NetAppSvmSnapMirrorPolicy", "storage.NetAppSvmSnapshotPolicy", "storage.NetAppVolume", "storage.NetAppVolumeEvent", "storage.NetAppVolumeSnapshot", "storage.NvmeRaidConfiguration", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PhysicalDiskUsage", "storage.PureArray", "storage.PureArrayAlerts", "storage.PureBlade", "storage.PureController", "storage.PureDirectory", "storage.PureDirectoryExport", "storage.PureDirectoryPolicy", "storage.PureDirectoryQuota", "storage.PureDirectorySnapshot", "storage.PureDisk", "storage.PureFileSystems", "storage.PureFlashBladeFileSystem", "storage.PureFlashBladeSystem", "storage.PureHost", "storage.PureHostGroup", "storage.PureHostLun", "storage.PureManagementAccessPolicy", "storage.PureNfsPolicyRule", "storage.PureObjectBucket", "storage.PureObjectStoreAccount", "storage.PureObjectStoreUser", "storage.PurePod", "storage.PurePort", "storage.PureProtectionGroup", "storage.PureProtectionGroupSnapshot", "storage.PureQuotaPolicyRule", "storage.PureRealm", "storage.PureReplicationSchedule", "storage.PureSmbPolicyRule", "storage.PureSnapshotSchedule", "storage.PureTargetArray", "storage.PureVolume", "storage.PureVolumeGroup", "storage.PureVolumeSnapshot", "storage.SasExpander", "storage.SasPort", "storage.Span", "storage.StoragePolicy", "storage.VdMemberEp", "storage.VirtualDrive", "storage.VirtualDriveContainer", "storage.VirtualDriveExtension", "storage.VirtualDriveIdentity", "syslog.Policy", "syslog.PolicyInventory", "tam.AdvisoryCount", "tam.AdvisoryDefinition", "tam.AdvisoryInfo", "tam.AdvisoryInstance", "tam.SecurityAdvisory", "task.CatalystSdwanScopedInventory", "task.FabricMosScopedInventory", "task.HciScopedInventory", "task.HitachiScopedInventory", "task.HyperFlexManagementScopedInventory", "task.HyperflexScopedInventory", "task.MdsScopedInventory", "task.MdsSystemScopedInventory", "task.MerakiScopedInventory", "task.NetAppScopedInventory", "task.NexusScopedInventory", "task.NexusSystemScopedInventory", "task.NexusVlanScopedInventory", "task.PureFlashBladeScopedInventory", "task.PureScopedInventory", "task.ServerScopedInventory", "techsupportmanagement.CollectionControlPolicy", "techsupportmanagement.Download", "techsupportmanagement.EndPoint", "techsupportmanagement.TechSupportBundle", "techsupportmanagement.TechSupportStatus", "terminal.AuditLog", "thermal.Policy", "thermal.PolicyInventory", "top.System", "ucsd.BackupInfo", "uuidpool.Block", "uuidpool.Pool", "uuidpool.PoolMember", "uuidpool.Reservation", "uuidpool.Universe", "uuidpool.UuidLease", "view.HealthStatus", "view.Server", "virtualization.EsxiConsole", "virtualization.Host", "virtualization.VirtualMachine", "virtualization.VmwareCluster", "virtualization.VmwareDatacenter", "virtualization.VmwareDatastore", "virtualization.VmwareDatastoreCluster", "virtualization.VmwareDistributedNetwork", "virtualization.VmwareDistributedSwitch", "virtualization.VmwareFolder", "virtualization.VmwareHost", "virtualization.VmwareHostGpu", "virtualization.VmwareKernelNetwork", "virtualization.VmwareNetwork", "virtualization.VmwarePhysicalNetworkInterface", "virtualization.VmwareProactiveHa", "virtualization.VmwareUplinkPort", "virtualization.VmwareVcenter", "virtualization.VmwareVirtualDisk", "virtualization.VmwareVirtualMachine", "virtualization.VmwareVirtualMachineGpu", "virtualization.VmwareVirtualMachineSnapshot", "virtualization.VmwareVirtualNetworkInterface", "virtualization.VmwareVirtualSwitch", "vmedia.Policy", "vmedia.PolicyInventory", "vmrc.Console", "vnic.EthAdapterPolicy", "vnic.EthAdapterPolicyInventory", "vnic.EthIf", "vnic.EthIfInventory", "vnic.EthNetworkPolicy", "vnic.EthNetworkPolicyInventory", "vnic.EthQosPolicy", "vnic.EthQosPolicyInventory", "vnic.EthVethInventory", "vnic.EthVnicInventory", "vnic.FcAdapterPolicy", "vnic.FcAdapterPolicyInventory", "vnic.FcIf", "vnic.FcIfInventory", "vnic.FcNetworkPolicy", "vnic.FcNetworkPolicyInventory", "vnic.FcQosPolicy", "vnic.FcQosPolicyInventory", "vnic.FcVethInventory", "vnic.FcVhbaPolicyInventory", "vnic.IscsiAdapterPolicy", "vnic.IscsiAdapterPolicyInventory", "vnic.IscsiBootPolicy", "vnic.IscsiBootPolicyInventory", "vnic.IscsiStaticTargetPolicy", "vnic.IscsiStaticTargetPolicyInventory", "vnic.LanConnectivityPolicy", "vnic.LanConnectivityPolicyInventory", "vnic.LanSettings", "vnic.LcpStatus", "vnic.SanConnectivityPolicy", "vnic.SanConnectivityPolicyInventory", "vnic.SanSettings", "vnic.ScpStatus", "vnic.ServiceEthIf", "vnic.ServiceEthIfInventory", "vnic.VhbaTemplate", "vnic.VifIdPool", "vnic.VnicTemplate", "vrf.Vrf", "webhook.Endpoint", "webhook.Schema", "workflow.AnsibleBatchExecutor", "workflow.BatchApiExecutor", "workflow.Catalog", "workflow.CatalogItemDefinition", "workflow.CatalogServiceRequest", "workflow.CustomDataTypeDefinition", "workflow.ErrorResponseHandler", "workflow.PowerShellBatchApiExecutor", "workflow.RollbackWorkflow", "workflow.ServiceItemActionDefinition", "workflow.ServiceItemActionInstance", "workflow.ServiceItemAttribute", "workflow.ServiceItemDefinition", "workflow.ServiceItemHealthCheckDefinition", "workflow.ServiceItemHealthCheckExecution", "workflow.ServiceItemInstance", "workflow.ServiceItemOutput", "workflow.SshBatchExecutor", "workflow.TaskDebugLog", "workflow.TaskDefinition", "workflow.TaskInfo", "workflow.TaskMetadata", "workflow.TemplateEvaluation", "workflow.TemplateFunctionMeta", "workflow.TemplateParser", "workflow.UiDisplayMetadata", "workflow.Variable", "workflow.WorkflowDefinition", "workflow.WorkflowInfo", "workflow.WorkflowMetadata", "workload.Blueprint", "workload.ClearWorkloadTag", "workload.DeploymentInput", "workload.WorkloadDefinition", "workload.WorkloadDeployment", "workload.WorkloadInstance", "workload.WorkloadMetadata" ], "x-enum-as-string": true }, "AccountMoid": { "description": "The Account ID for this managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "CreateTime": { "description": "The time when this managed object was created.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "DomainGroupMoid": { "description": "The DomainGroup ID for this managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "ModTime": { "description": "The time when this managed object was last modified.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Moid": { "description": "The unique identifier of this Managed Object instance.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Owners": { "type": "array", "items": { "description": "The array of owners which represent effective ownership of this object.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SharedScope": { "description": "Intersight provides pre-built workflows, tasks and policies to end users through global catalogs.\nObjects that are made available through global catalogs are said to have a 'shared' ownership. Shared objects are either made globally available to all end users or restricted to end users based on their license entitlement. Users can use this property to differentiate the scope (global or a specific license tier) to which a shared MO belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "Tags": { "type": "array", "items": { "description": "The array of tags, which allow to add key, value meta-data to managed objects.", "$ref": "#/components/schemas/mo.Tag", "x-omitempty": true }, "nullable": true }, "VersionContext": { "description": "The versioning info for this managed object.", "$ref": "#/components/schemas/mo.VersionContext", "readOnly": true, "x-omitempty": true }, "Ancestors": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "Parent": { "$ref": "#/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 }, "PermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "DisplayNames": { "$ref": "#/components/schemas/DisplayNames" } } }, "mo.MoRef": { "title": "Mo:Mo Ref", "description": "A reference to a REST resource, uniquely identified by object type and Moid.", "required": [ "ClassId", "ObjectType", "objectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "type": "string", "enum": [ "mo.MoRef" ], "default": "mo.MoRef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the remote type referred by this relationship.", "type": "string", "enum": [ "aaa.AuditRecord", "aaa.RetentionConfig", "aaa.RetentionPolicy", "access.IpAddress", "access.Policy", "access.PolicyInventory", "adapter.ConfigPolicy", "adapter.ExtEthInterface", "adapter.HostEthInterface", "adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "apic.AciPod", "apic.Application", "apic.ApplicationEndpointGroup", "apic.BridgeDomain", "apic.ExternalRoutedLayerThreeDomain", "apic.FabricLeafNode", "apic.FabricLeafNodeInterface", "apic.Out", "apic.Subnet", "apic.Tenant", "apic.VpcGroup", "apic.Vrfs", "apiproxy.AllowList", "appliance.AppOpStatus", "appliance.AppStatus", "appliance.AutoRmaPolicy", "appliance.Backup", "appliance.BackupDownload", "appliance.BackupMonitor", "appliance.BackupPolicy", "appliance.BackupRotateData", "appliance.CertificateSetting", "appliance.ClusterInfo", "appliance.ClusterInstall", "appliance.ClusterReplaceNode", "appliance.ClusterWorkerNode", "appliance.ClusterWorkerNodeReplace", "appliance.ClusterWorkerNodeReuse", "appliance.CpuUtilization", "appliance.DataExportPolicy", "appliance.DeviceCertificate", "appliance.DeviceClaim", "appliance.DeviceClusterInstall", "appliance.DeviceState", "appliance.DeviceUpgradePolicy", "appliance.DiagSetting", "appliance.ExternalSyslogSetting", "appliance.FileGateway", "appliance.FileSystemOpStatus", "appliance.FileSystemOpSummary", "appliance.FileSystemStatus", "appliance.FileSystemTelemetry", "appliance.FqdnUpdate", "appliance.GroupOpStatus", "appliance.GroupStatus", "appliance.ImageBundle", "appliance.MemoryUtilization", "appliance.MetaManifest", "appliance.MetricsConfig", "appliance.MetricsIngestionUtilization", "appliance.NetworkLinkStatus", "appliance.NodeInfo", "appliance.NodeIopsMetric", "appliance.NodeOpStatus", "appliance.NodeStatus", "appliance.NodeTelemetry", "appliance.ReleaseNote", "appliance.RemoteFileImport", "appliance.Restore", "appliance.SetupInfo", "appliance.SystemInfo", "appliance.SystemOpStatus", "appliance.SystemStatus", "appliance.Upgrade", "appliance.UpgradePolicy", "appliance.UpgradeTracker", "asset.ClaimToken", "asset.ClusterMember", "asset.Deployment", "asset.DeploymentDevice", "asset.DeviceClaim", "asset.DeviceConfiguration", "asset.DeviceConnectorManager", "asset.DeviceContractInformation", "asset.DeviceContractNotification", "asset.DeviceRegistration", "asset.GeoLocation", "asset.PreClaim", "asset.Subscription", "asset.SubscriptionAccount", "asset.SubscriptionDeviceContractInformation", "asset.Target", "auditd.Policy", "bios.BootDevice", "bios.BootMode", "bios.Policy", "bios.SystemBootOrder", "bios.TokenSettings", "bios.Unit", "bios.VfSelectMemoryRasConfiguration", "boot.CddDevice", "boot.DeviceBootMode", "boot.DeviceBootSecurity", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PrecisionPolicy", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "bulk.Export", "bulk.ExportedItem", "bulk.MoCloner", "bulk.MoDeepCloner", "bulk.MoMerger", "bulk.Request", "bulk.Result", "bulk.SubRequestObj", "capability.ActionsMetaData", "capability.AdapterDeprecatedDef", "capability.AdapterFirmwareRequirement", "capability.AdapterUnitDescriptor", "capability.AdapterUpdateConstraintMeta", "capability.AdapterUpgradeSupportMeta", "capability.BiosTokens", "capability.Catalog", "capability.ChassisDescriptor", "capability.ChassisManufacturingDef", "capability.ChassisUpgradeSupportMeta", "capability.CimcFirmwareDescriptor", "capability.CpuEndpointDescriptor", "capability.DimmsEndpointDescriptor", "capability.DomainPolicyRequirement", "capability.DrivesEndpointDescriptor", "capability.EquipmentPhysicalDef", "capability.EquipmentSlotArray", "capability.FanModuleDescriptor", "capability.FanModuleManufacturingDef", "capability.FexCapabilityDef", "capability.FexDescriptor", "capability.FexManufacturingDef", "capability.FexSupportMeta", "capability.GpuEndpointDescriptor", "capability.HsuIsoFileSupportMeta", "capability.IoCardCapabilityDef", "capability.IoCardDescriptor", "capability.IoCardManufacturingDef", "capability.IomUpgradeSupportMeta", "capability.NetworkEquipmentPowerDef", "capability.PolicyConstants", "capability.PortGroupAggregationDef", "capability.ProcessorUnitUpdateConstraintMeta", "capability.PsuDescriptor", "capability.PsuManufacturingDef", "capability.ServerActionsMeta", "capability.ServerDescriptor", "capability.ServerModelsCapabilityDef", "capability.ServerPcieConnectivityCatalog", "capability.ServerSchemaDescriptor", "capability.ServerTopologyMap", "capability.ServerUpgradeSupportMeta", "capability.SiocModuleCapabilityDef", "capability.SiocModuleDescriptor", "capability.SiocModuleManufacturingDef", "capability.StandardRedfishSupportMeta", "capability.StorageControllerUpdateConstraintMeta", "capability.StorageControllersMetaData", "capability.SwitchCapability", "capability.SwitchDescriptor", "capability.SwitchEquipmentInfo", "capability.SwitchManufacturingDef", "capability.SwitchUpgradeSupportMeta", "capability.TemplateCatalog", "capability.TimeZoneMetaData", "capability.UpdateOrderMeta", "capability.VicDescriptor", "catalystsdwan.ConfigGroup", "catalystsdwan.Interface", "catalystsdwan.PhysicalPort", "catalystsdwan.PolicyGroup", "catalystsdwan.PortChannel", "catalystsdwan.VedgeDevice", "catalystsdwan.Vlan", "catalystsdwan.WanEdgeDevice", "certificatemanagement.Policy", "certificatemanagement.PolicyInventory", "chassis.ConfigChangeDetail", "chassis.ConfigImport", "chassis.ConfigResult", "chassis.ConfigResultEntry", "chassis.IomProfile", "chassis.Profile", "chassis.ProfileTemplate", "cli.CliPolicy", "cloud.CollectInventory", "cloud.TfcAgentpool", "cloud.TfcOrganization", "cloud.TfcWorkspace", "comm.HttpProxyPolicy", "comm.TagDefinition", "compute.Blade", "compute.BladeIdentity", "compute.Board", "compute.DownloadStatus", "compute.HostUtilityOperation", "compute.Mapping", "compute.PcieConnectivityPolicy", "compute.PcieConnectivityPolicyInventory", "compute.Personality", "compute.PhysicalSummary", "compute.RackUnit", "compute.RackUnitIdentity", "compute.ScrubPolicy", "compute.ServerIdPool", "compute.ServerPowerParameters", "compute.ServerPowerPolicy", "compute.ServerSetting", "compute.Vmedia", "cond.Alarm", "cond.AlarmAggregation", "cond.AlarmClassification", "cond.AlarmDefinition", "cond.AlarmRule", "cond.AlarmSuppression", "cond.AlarmSuppressionDryRun", "cond.CustomHclBaseline", "cond.CustomHclStatus", "cond.HclStatus", "cond.HclStatusDetail", "cond.HclStatusJob", "cond.ThresholdDefinition", "connectorpack.ConnectorPackUpgrade", "connectorpack.UpgradeImpact", "console.ConsoleConfig", "convergedinfra.AdapterComplianceDetails", "convergedinfra.Pod", "convergedinfra.PodComplianceInfo", "convergedinfra.ServerComplianceDetails", "convergedinfra.StorageComplianceDetails", "convergedinfra.SwitchComplianceDetails", "coremanagement.CoreFile", "coremanagement.Download", "crd.CustomResource", "deviceconnector.Policy", "dnac.Device", "dnac.DeviceInterface", "dnac.ExternalBorderNode", "dnac.ExternalBorderNodeInterface", "dnac.FabricSite", "dnac.Site", "dnac.SiteIpPool", "dnac.Template", "dnac.Transit", "dnac.VirtualNetworkFabricSite", "energy.DailyMetrics", "energy.Metrics", "equipment.Chassis", "equipment.ChassisController", "equipment.ChassisIdPool", "equipment.ChassisIdentity", "equipment.ChassisOperation", "equipment.DeviceSummary", "equipment.EnclosureElement", "equipment.EndPointLog", "equipment.ExpanderModule", "equipment.ExpanderModuleIdentity", "equipment.ExpanderModuleOperation", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.FexIdentity", "equipment.FexOperation", "equipment.Fru", "equipment.HybridDriveSlot", "equipment.Interconnect", "equipment.IoCard", "equipment.IoCardOperation", "equipment.IoExpander", "equipment.LocatorLed", "equipment.LogDownload", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.Riser", "equipment.Sensor", "equipment.SharedAdapterUnit", "equipment.SharedGraphicsCard", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SwitchOperation", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "ether.HostPort", "ether.InterSwitchPort", "ether.LanPort", "ether.NetworkPort", "ether.PhysicalPort", "ether.PortChannel", "externalsite.Authorization", "fabric.AppliancePcRole", "fabric.ApplianceRole", "fabric.ConfigChangeDetail", "fabric.ConfigResult", "fabric.ConfigResultEntry", "fabric.ElementIdentity", "fabric.EstimateImpact", "fabric.EthNetworkControlPolicy", "fabric.EthNetworkControlPolicyInventory", "fabric.EthNetworkGroupPolicy", "fabric.EthNetworkGroupPolicyInventory", "fabric.EthNetworkPolicy", "fabric.FcNetworkPolicy", "fabric.FcStorageRole", "fabric.FcUplinkPcRole", "fabric.FcUplinkRole", "fabric.FcZonePolicy", "fabric.FcoeUplinkPcRole", "fabric.FcoeUplinkRole", "fabric.FlowControlPolicy", "fabric.LanPinGroup", "fabric.LinkAggregationPolicy", "fabric.LinkControlPolicy", "fabric.MacSecPolicy", "fabric.MulticastPolicy", "fabric.NetFlowExporter", "fabric.NetFlowMonitor", "fabric.NetFlowPolicy", "fabric.NetFlowRecord", "fabric.PcMember", "fabric.PcOperation", "fabric.PortMode", "fabric.PortOperation", "fabric.PortPolicy", "fabric.SanPinGroup", "fabric.SecureRouterRole", "fabric.ServerRole", "fabric.SpanDestEthPort", "fabric.SpanSession", "fabric.SpanSourceEthPort", "fabric.SpanSourceEthPortChannel", "fabric.SpanSourceVlan", "fabric.SpanSourceVnicEthIf", "fabric.SwitchClusterProfile", "fabric.SwitchClusterProfileTemplate", "fabric.SwitchControlPolicy", "fabric.SwitchProfile", "fabric.SwitchProfileTemplate", "fabric.SystemQosPolicy", "fabric.UplinkPcRole", "fabric.UplinkRole", "fabric.Vlan", "fabric.VlanInventory", "fabric.VlanSet", "fabric.Vsan", "fabric.VsanInventory", "fault.Instance", "fc.Neighbor", "fc.PhysicalPort", "fc.PortChannel", "fcpool.FcBlock", "fcpool.Lease", "fcpool.Pool", "fcpool.PoolMember", "fcpool.Reservation", "fcpool.Universe", "feedback.FeedbackPost", "firmware.BiosDescriptor", "firmware.BoardControllerDescriptor", "firmware.ChassisUpgrade", "firmware.CimcDescriptor", "firmware.DimmDescriptor", "firmware.Distributable", "firmware.DistributableMeta", "firmware.DriveDescriptor", "firmware.DriverDistributable", "firmware.Eula", "firmware.FirmwareSummary", "firmware.GpuDescriptor", "firmware.HbaDescriptor", "firmware.IomDescriptor", "firmware.MswitchDescriptor", "firmware.NxosDescriptor", "firmware.PciNodeUpgrade", "firmware.PcieDescriptor", "firmware.Policy", "firmware.PsuDescriptor", "firmware.PsxDescriptor", "firmware.RunningFirmware", "firmware.SasExpanderDescriptor", "firmware.SecureRouterUpgrade", "firmware.ServerConfigurationUtilityDistributable", "firmware.StorageControllerDescriptor", "firmware.SwitchUpgrade", "firmware.UnsupportedVersionUpgrade", "firmware.Upgrade", "firmware.UpgradeImpact", "firmware.UpgradeImpactStatus", "firmware.UpgradeStatus", "firmware.UpgradeValidity", "fmc.Device", "fmc.DeviceHaPair", "fmc.Domain", "fmc.PhysicalInterface", "forecast.Catalog", "forecast.Definition", "forecast.Instance", "graphics.Card", "graphics.Controller", "hci.AhvVm", "hci.AhvVmDisk", "hci.AhvVmGpu", "hci.AhvVmNic", "hci.Alarm", "hci.Cluster", "hci.ClusterOperation", "hci.Compliance", "hci.Disk", "hci.DomainManager", "hci.Entitlement", "hci.EsxiVm", "hci.EsxiVmDisk", "hci.EsxiVmNic", "hci.ExternalStorage", "hci.Gpu", "hci.License", "hci.NccCheckPolicy", "hci.Node", "hci.PhysicalGpu", "hci.StorageContainer", "hci.Violation", "hci.VirtualGpu", "hcl.CompatibilityStatus", "hcl.DataImportLog", "hcl.DriverImage", "hcl.ExemptedCatalog", "hcl.HwCatalogInfo", "hcl.HyperflexSoftwareCompatibilityInfo", "hcl.OperatingSystem", "hcl.OperatingSystemVendor", "hcl.ServerCatalog", "hcl.ServerHwCatalogInfo", "hcl.SupportedDriverName", "hyperflex.Alarm", "hyperflex.AppCatalog", "hyperflex.AutoSupportPolicy", "hyperflex.BackupCluster", "hyperflex.CapabilityInfo", "hyperflex.Cluster", "hyperflex.ClusterBackupPolicy", "hyperflex.ClusterBackupPolicyDeployment", "hyperflex.ClusterBackupPolicyInventory", "hyperflex.ClusterHealthCheckExecutionSnapshot", "hyperflex.ClusterNetworkPolicy", "hyperflex.ClusterProfile", "hyperflex.ClusterReplicationNetworkPolicy", "hyperflex.ClusterReplicationNetworkPolicyDeployment", "hyperflex.ClusterStoragePolicy", "hyperflex.ConfigResult", "hyperflex.ConfigResultEntry", "hyperflex.DataProtectionPeer", "hyperflex.DatastoreStatistic", "hyperflex.DevicePackageDownloadState", "hyperflex.Drive", "hyperflex.Encryption", "hyperflex.ExtFcStoragePolicy", "hyperflex.ExtIscsiStoragePolicy", "hyperflex.FeatureLimitExternal", "hyperflex.FeatureLimitInternal", "hyperflex.Health", "hyperflex.HealthCheckDefinition", "hyperflex.HealthCheckExecution", "hyperflex.HealthCheckExecutionSnapshot", "hyperflex.HealthCheckPackageChecksum", "hyperflex.HealthCheckSchedulePolicy", "hyperflex.HwCatalog", "hyperflex.HxdpVersion", "hyperflex.HypervisorHost", "hyperflex.HypervisorVirtualMachine", "hyperflex.InitiatorGroup", "hyperflex.IscsiNetwork", "hyperflex.KeyEncryptionKey", "hyperflex.License", "hyperflex.LocalCredentialPolicy", "hyperflex.Lun", "hyperflex.Node", "hyperflex.NodeConfigPolicy", "hyperflex.NodeProfile", "hyperflex.ProtectedCluster", "hyperflex.ProxySettingPolicy", "hyperflex.ReduceReSync", "hyperflex.ServerFirmwareVersion", "hyperflex.ServerFirmwareVersionEntry", "hyperflex.ServerModel", "hyperflex.ServiceAuthToken", "hyperflex.SoftwareDistributionComponent", "hyperflex.SoftwareDistributionEntry", "hyperflex.SoftwareDistributionVersion", "hyperflex.SoftwareVersionPolicy", "hyperflex.StartReduceReSync", "hyperflex.StorageContainer", "hyperflex.SysConfigPolicy", "hyperflex.Target", "hyperflex.UcsmConfigPolicy", "hyperflex.VcenterConfigPolicy", "hyperflex.VmBackupInfo", "hyperflex.VmImportOperation", "hyperflex.VmRestoreOperation", "hyperflex.VmSnapshotInfo", "hyperflex.Volume", "hyperflex.WitnessConfiguration", "iaas.ConnectorPack", "iaas.CustomTaskInfo", "iaas.DeviceStatus", "iaas.DiagnosticMessages", "iaas.LicenseInfo", "iaas.MostRunTasks", "iaas.ServiceRequest", "iaas.SystemTaskInfo", "iaas.UcsdInfo", "iaas.UcsdManagedInfra", "iaas.UcsdMessages", "iam.Account", "iam.AccountExperience", "iam.ApiKey", "iam.AppRegistration", "iam.BannerMessage", "iam.Certificate", "iam.CertificateRequest", "iam.CuiIntegration", "iam.DefaultAuthentication", "iam.DomainGroup", "iam.DomainNameInfo", "iam.EndPointPrivilege", "iam.EndPointRole", "iam.EndPointUser", "iam.EndPointUserInventory", "iam.EndPointUserPolicy", "iam.EndPointUserPolicyInventory", "iam.EndPointUserRole", "iam.EndPointUserRoleInventory", "iam.GuestAccessSettings", "iam.Idp", "iam.IdpReference", "iam.IpAccessManagement", "iam.IpAddress", "iam.LdapConfigParams", "iam.LdapGroup", "iam.LdapGroupInventory", "iam.LdapMeta", "iam.LdapPolicy", "iam.LdapPolicyInventory", "iam.LdapProvider", "iam.LdapProviderInventory", "iam.LocalUserPassword", "iam.LocalUserPasswordPolicy", "iam.OAuthToken", "iam.PasswordHistorySettingCollection", "iam.Permission", "iam.PrivateKeySpec", "iam.Privilege", "iam.PrivilegeSet", "iam.PrivilegeSetMetaInfo", "iam.Qualifier", "iam.ResourceLimits", "iam.ResourcePermission", "iam.ResourceRoles", "iam.Role", "iam.SecurityHolder", "iam.ServiceProvider", "iam.Session", "iam.SessionLimits", "iam.SharingRule", "iam.System", "iam.TestIdpConfiguration", "iam.TrustPoint", "iam.User", "iam.UserGroup", "iam.UserPreference", "iam.UserQualifier", "iam.UserSetting", "inventory.DeviceInfo", "inventory.DnMoBinding", "inventory.GenericInventory", "inventory.GenericInventoryHolder", "inventory.Request", "ipmioverlan.Policy", "ipmioverlan.PolicyInventory", "ippool.BlockLease", "ippool.IpLease", "ippool.Pool", "ippool.PoolMember", "ippool.Reservation", "ippool.ShadowBlock", "ippool.ShadowPool", "ippool.Universe", "iqnpool.Block", "iqnpool.Lease", "iqnpool.Pool", "iqnpool.PoolMember", "iqnpool.Reservation", "iqnpool.Universe", "iwotenant.MaintenanceNotification", "iwotenant.Migrate", "iwotenant.TenantCustomization", "iwotenant.TenantStatus", "kvm.Policy", "kvm.PolicyInventory", "kvm.Session", "kvm.Tunnel", "kvm.TunneledKvmPolicy", "license.AccountLicenseData", "license.CustomerOp", "license.ErpCustomerOp", "license.ErpLicenseCount", "license.IksCustomerOp", "license.IksLicenseCount", "license.IncCustomerOp", "license.IncLicenseCount", "license.IwoCustomerOp", "license.IwoLicenseCount", "license.LicenseInfo", "license.LicenseInfoView", "license.LicenseRegistrationStatus", "license.LicenseReservationOp", "license.SmartlicenseToken", "ls.ServiceProfile", "macpool.IdBlock", "macpool.Lease", "macpool.Pool", "macpool.PoolMember", "macpool.Reservation", "macpool.Universe", "management.Controller", "management.Entity", "management.Interface", "memory.Array", "memory.PersistentMemoryConfigResult", "memory.PersistentMemoryConfiguration", "memory.PersistentMemoryNamespace", "memory.PersistentMemoryNamespaceConfigResult", "memory.PersistentMemoryPolicy", "memory.PersistentMemoryRegion", "memory.PersistentMemoryUnit", "memory.Policy", "memory.PolicyInventory", "memory.Unit", "meraki.Device", "meraki.Network", "meraki.Organization", "meraki.PortProfile", "meraki.Tag", "meta.Definition", "metrics.Configuration", "metrics.MetricsExploration", "metrics.ResourceConfiguration", "mgmt.BackupCategory", "mgmt.ConfigBackupFile", "mgmt.ConfigBackupInstance", "mgmt.ConfigBackupOperation", "mgmt.ConfigCategorySummary", "mgmt.ConfigOperationSetting", "mgmt.ConfigRestoreCategorySummary", "mgmt.ConfigRestoreOperation", "mgmt.ObjectBackupMeta", "mgmt.OrgBackupOperation", "mgmt.OrgRestoreOperation", "monitoring.HealthStatus", "network.DiscoveredNeighbor", "network.Dns", "network.Element", "network.ElementSummary", "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", "networkconfig.Policy", "networkconfig.PolicyInventory", "niaapi.ApicCcoPost", "niaapi.ApicFieldNotice", "niaapi.ApicHweol", "niaapi.ApicLatestMaintainedRelease", "niaapi.ApicReleaseRecommend", "niaapi.ApicSweol", "niaapi.DcnmCcoPost", "niaapi.DcnmFieldNotice", "niaapi.DcnmHweol", "niaapi.DcnmLatestMaintainedRelease", "niaapi.DcnmReleaseRecommend", "niaapi.DcnmSweol", "niaapi.FileDownloader", "niaapi.NdEncryptedFileDownload", "niaapi.NdMetadata", "niaapi.NdMetadataFileDownloader", "niaapi.NdMetadataSoftwareDownload", "niaapi.NiaMetadata", "niaapi.NibFileDownloader", "niaapi.NibMetadata", "niaapi.PuvScriptDownloader", "niaapi.SnValidatorMetadata", "niaapi.UpgradeAssistFile", "niaapi.VersionRegex", "niatelemetry.AaaLdapProviderDetails", "niatelemetry.AaaRadiusProviderDetails", "niatelemetry.AaaTacacsProviderDetails", "niatelemetry.Anomaly", "niatelemetry.ApicAppPluginDetails", "niatelemetry.ApicCoreFileDetails", "niatelemetry.ApicDbgexpRsExportDest", "niatelemetry.ApicDbgexpRsTsScheduler", "niatelemetry.ApicFanDetails", "niatelemetry.ApicFexDetails", "niatelemetry.ApicFlashDetails", "niatelemetry.ApicNtpAuth", "niatelemetry.ApicPerformanceData", "niatelemetry.ApicPodData", "niatelemetry.ApicPsuDetails", "niatelemetry.ApicRealmDetails", "niatelemetry.ApicSnmpClientGrpDetails", "niatelemetry.ApicSnmpCommunityAccessDetails", "niatelemetry.ApicSnmpCommunityDetails", "niatelemetry.ApicSnmpTrapDetails", "niatelemetry.ApicSnmpTrapFwdServerDetails", "niatelemetry.ApicSnmpVersionThreeDetails", "niatelemetry.ApicSysLogGrp", "niatelemetry.ApicSysLogSrc", "niatelemetry.ApicTransceiverDetails", "niatelemetry.ApicUiPageCounts", "niatelemetry.ApicVision", "niatelemetry.AppDetails", "niatelemetry.CloudDetails", "niatelemetry.Cluster", "niatelemetry.ClusterNode", "niatelemetry.CommonPolicies", "niatelemetry.Controller", "niatelemetry.DcnmFanDetails", "niatelemetry.DcnmFexDetails", "niatelemetry.DcnmModuleDetails", "niatelemetry.DcnmPsuDetails", "niatelemetry.DcnmTransceiverDetails", "niatelemetry.DomInfoObject", "niatelemetry.DomThresInfoObject", "niatelemetry.Epg", "niatelemetry.Fabric", "niatelemetry.FabricModuleDetails", "niatelemetry.FabricNodeControlDetails", "niatelemetry.FabricPodProfile", "niatelemetry.FabricPodSs", "niatelemetry.Fault", "niatelemetry.HcloudDetails", "niatelemetry.HealthInsightsData", "niatelemetry.HttpsAclContractDetails", "niatelemetry.HttpsAclContractFilterMap", "niatelemetry.HttpsAclEpgContractMap", "niatelemetry.HttpsAclEpgDetails", "niatelemetry.HttpsAclFilterDetails", "niatelemetry.InsightGroupDetails", "niatelemetry.Lc", "niatelemetry.LeafPolGrpDetails", "niatelemetry.Link", "niatelemetry.MdsNeighbors", "niatelemetry.MsoContractDetails", "niatelemetry.MsoEpgDetails", "niatelemetry.MsoSchemaDetails", "niatelemetry.MsoSiteDetails", "niatelemetry.MsoTenantDetails", "niatelemetry.Neighbor", "niatelemetry.Network", "niatelemetry.NexusCloudAccount", "niatelemetry.NexusCloudSite", "niatelemetry.NexusDashboardControllerDetails", "niatelemetry.NexusDashboardDetails", "niatelemetry.NexusDashboardMemoryDetails", "niatelemetry.NexusDashboards", "niatelemetry.NiaFeatureUsage", "niatelemetry.NiaInventory", "niatelemetry.NiaInventoryDcnm", "niatelemetry.NiaInventoryFabric", "niatelemetry.NiaLicenseState", "niatelemetry.Nicc", "niatelemetry.PasswordStrengthCheck", "niatelemetry.PodCommPolicies", "niatelemetry.PodSnmpPolicies", "niatelemetry.PodTimeServerPolicies", "niatelemetry.Route", "niatelemetry.SiteInventory", "niatelemetry.SnmpSrc", "niatelemetry.SpinePolGrpDetails", "niatelemetry.SshVersionTwo", "niatelemetry.SupervisorModuleDetails", "niatelemetry.Switch", "niatelemetry.SwitchInterface", "niatelemetry.SyslogRemoteDest", "niatelemetry.SyslogSysMsg", "niatelemetry.SyslogSysMsgFacFilter", "niatelemetry.SystemControllerDetails", "niatelemetry.Tenant", "notification.AccountSubscription", "ntp.NtpServer", "ntp.Policy", "ntp.PolicyInventory", "oauth.AccessToken", "oauth.Authorization", "onprem.ApplianceSystemInfo", "onprem.AuditRecord", "onprem.Upgrade", "onprem.UserPreference", "openapi.ApiMethodMeta", "openapi.OpenApiSpecification", "openapi.ProcessFile", "openapi.TaskGenerationRequest", "openapi.TaskGenerationResult", "oprs.Deployment", "oprs.SyncTargetListMessage", "organization.Organization", "os.BulkInstallInfo", "os.Catalog", "os.ConfigurationFile", "os.Distribution", "os.Install", "os.OsSupport", "os.SupportedVersion", "os.TemplateFile", "os.ValidInstallTarget", "os.ValidRemoteTarget", "partnerintegration.DcLogs", "partnerintegration.DeviceConnector", "partnerintegration.DocIssues", "partnerintegration.Etl", "partnerintegration.File", "partnerintegration.Inventory", "partnerintegration.Logs", "partnerintegration.Metrics", "partnerintegration.Model", "pci.CoprocessorCard", "pci.Device", "pci.Endpoint", "pci.Link", "pci.Node", "pci.NodeSetting", "pci.Port", "pci.Slot", "pci.Switch", "pci.Zone", "pool.IdMappingMember", "pool.IdMappingPolicy", "port.Group", "port.MacBinding", "port.SubGroup", "power.ControlState", "power.Policy", "power.PolicyInventory", "power.PowerGroup", "power.PowerGroupMember", "processor.Unit", "rack.UnitPersonality", "recommendation.CapacityRunway", "recommendation.ClusterExpansion", "recommendation.HardwareExpansionRequest", "recommendation.HardwareExpansionRequestItem", "recommendation.PhysicalItem", "recommendation.PurchaseOrderEstimate", "recommendation.PurchaseOrderList", "recommendation.SoftwareItem", "recovery.BackupConfigPolicy", "recovery.BackupProfile", "recovery.ConfigResult", "recovery.ConfigResultEntry", "recovery.OnDemandBackup", "recovery.Restore", "recovery.ScheduleConfigPolicy", "resource.Group", "resource.GroupMember", "resource.LicenseResourceCount", "resource.Membership", "resource.MembershipHolder", "resource.Reservation", "resource.SelectionCriteria", "resource.SharedResourcesInfoHolder", "resourcepool.ChassisQualificationPolicy", "resourcepool.Lease", "resourcepool.LeaseResource", "resourcepool.MembershipReservation", "resourcepool.Pool", "resourcepool.PoolMember", "resourcepool.QualificationPolicy", "resourcepool.Reservation", "resourcepool.Universe", "rproxy.ReverseProxy", "scheduler.SchedulePolicy", "scheduler.TaskResult", "scheduler.TaskSchedule", "sdaaci.Connection", "sdaaci.ConnectionDetail", "sdcard.Policy", "sdcard.PolicyInventory", "search.SearchItem", "search.TagItem", "security.Unit", "server.ConfigChangeDetail", "server.ConfigImport", "server.ConfigResult", "server.ConfigResultEntry", "server.DiagnosticStatus", "server.Diagnostics", "server.Disruption", "server.MigrationKeyDetails", "server.Profile", "server.ProfilePendingChangeEval", "server.ProfileTemplate", "servicenow.ChangeRequest", "servicenow.ChangeRequestDoc", "servicenow.Incident", "servicenow.IncidentDoc", "smtp.Policy", "smtp.PolicyInventory", "smtp.PolicyTest", "snmp.Policy", "snmp.PolicyInventory", "software.ApplianceDistributable", "software.DownloadHistory", "software.HciBundleDistributable", "software.HciDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.IksBundleDistributable", "software.ReleaseMeta", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable", "softwarerepository.Authorization", "softwarerepository.CachedImage", "softwarerepository.Catalog", "softwarerepository.CategoryMapper", "softwarerepository.CategoryMapperModel", "softwarerepository.CategorySupportConstraint", "softwarerepository.CategoryUnsupportedModels", "softwarerepository.DownloadSpec", "softwarerepository.OperatingSystemFile", "softwarerepository.Release", "sol.Policy", "sol.PolicyInventory", "ssh.Policy", "ssh.PolicyInventory", "storage.BatteryBackupUnit", "storage.Controller", "storage.ControllerDrive", "storage.DiskGroup", "storage.DiskSlot", "storage.DriveGroup", "storage.DriveSecurityPolicy", "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.HitachiExternalParityGroup", "storage.HitachiExternalPathGroup", "storage.HitachiExternalStorageLun", "storage.HitachiExternalStoragePort", "storage.HitachiHost", "storage.HitachiHostLun", "storage.HitachiNvmSubsystem", "storage.HitachiParityGroup", "storage.HitachiPool", "storage.HitachiPort", "storage.HitachiRemoteCopyPairGad", "storage.HitachiRemoteCopyPairTc", "storage.HitachiRemoteCopyPairUr", "storage.HitachiRemoteReplication", "storage.HitachiSnapshot", "storage.HitachiVolume", "storage.HitachiVolumeMigrationPair", "storage.HyperFlexStorageContainer", "storage.HyperFlexVolume", "storage.Item", "storage.KnoxSecureDriveConfiguration", "storage.NetAppAggregate", "storage.NetAppAggregateEvent", "storage.NetAppBaseDisk", "storage.NetAppCifsService", "storage.NetAppCifsShare", "storage.NetAppCloudTarget", "storage.NetAppCluster", "storage.NetAppClusterEvent", "storage.NetAppClusterSnapMirrorPolicy", "storage.NetAppClusterSnapshotPolicy", "storage.NetAppDataIpInterface", "storage.NetAppDataIpInterfaceEvent", "storage.NetAppDiskEvent", "storage.NetAppEthernetPort", "storage.NetAppEthernetPortEvent", "storage.NetAppExportPolicy", "storage.NetAppFcInterface", "storage.NetAppFcInterfaceEvent", "storage.NetAppFcPort", "storage.NetAppFcPortEvent", "storage.NetAppInitiatorGroup", "storage.NetAppIpInterface", "storage.NetAppIpInterfaceEvent", "storage.NetAppIscsiService", "storage.NetAppLicense", "storage.NetAppLun", "storage.NetAppLunEvent", "storage.NetAppLunMap", "storage.NetAppNamespace", "storage.NetAppNfsClient", "storage.NetAppNfsService", "storage.NetAppNode", "storage.NetAppNodeCdpNeighbor", "storage.NetAppNodeEvent", "storage.NetAppNonDataIpInterface", "storage.NetAppNonDataIpInterfaceEvent", "storage.NetAppNtpServer", "storage.NetAppQtree", "storage.NetAppSchedule", "storage.NetAppSensor", "storage.NetAppSnapMirrorRelationship", "storage.NetAppStorageVm", "storage.NetAppSvmEvent", "storage.NetAppSvmSnapMirrorPolicy", "storage.NetAppSvmSnapshotPolicy", "storage.NetAppVolume", "storage.NetAppVolumeEvent", "storage.NetAppVolumeSnapshot", "storage.NvmeRaidConfiguration", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PhysicalDiskUsage", "storage.PureArray", "storage.PureArrayAlerts", "storage.PureBlade", "storage.PureController", "storage.PureDirectory", "storage.PureDirectoryExport", "storage.PureDirectoryPolicy", "storage.PureDirectoryQuota", "storage.PureDirectorySnapshot", "storage.PureDisk", "storage.PureFileSystems", "storage.PureFlashBladeFileSystem", "storage.PureFlashBladeSystem", "storage.PureHost", "storage.PureHostGroup", "storage.PureHostLun", "storage.PureManagementAccessPolicy", "storage.PureNfsPolicyRule", "storage.PureObjectBucket", "storage.PureObjectStoreAccount", "storage.PureObjectStoreUser", "storage.PurePod", "storage.PurePort", "storage.PureProtectionGroup", "storage.PureProtectionGroupSnapshot", "storage.PureQuotaPolicyRule", "storage.PureRealm", "storage.PureReplicationSchedule", "storage.PureSmbPolicyRule", "storage.PureSnapshotSchedule", "storage.PureTargetArray", "storage.PureVolume", "storage.PureVolumeGroup", "storage.PureVolumeSnapshot", "storage.SasExpander", "storage.SasPort", "storage.Span", "storage.StoragePolicy", "storage.VdMemberEp", "storage.VirtualDrive", "storage.VirtualDriveContainer", "storage.VirtualDriveExtension", "storage.VirtualDriveIdentity", "syslog.Policy", "syslog.PolicyInventory", "tam.AdvisoryCount", "tam.AdvisoryDefinition", "tam.AdvisoryInfo", "tam.AdvisoryInstance", "tam.SecurityAdvisory", "task.CatalystSdwanScopedInventory", "task.FabricMosScopedInventory", "task.HciScopedInventory", "task.HitachiScopedInventory", "task.HyperFlexManagementScopedInventory", "task.HyperflexScopedInventory", "task.MdsScopedInventory", "task.MdsSystemScopedInventory", "task.MerakiScopedInventory", "task.NetAppScopedInventory", "task.NexusScopedInventory", "task.NexusSystemScopedInventory", "task.NexusVlanScopedInventory", "task.PureFlashBladeScopedInventory", "task.PureScopedInventory", "task.ServerScopedInventory", "techsupportmanagement.CollectionControlPolicy", "techsupportmanagement.Download", "techsupportmanagement.EndPoint", "techsupportmanagement.TechSupportBundle", "techsupportmanagement.TechSupportStatus", "terminal.AuditLog", "thermal.Policy", "thermal.PolicyInventory", "top.System", "ucsd.BackupInfo", "uuidpool.Block", "uuidpool.Pool", "uuidpool.PoolMember", "uuidpool.Reservation", "uuidpool.Universe", "uuidpool.UuidLease", "view.HealthStatus", "view.Server", "virtualization.EsxiConsole", "virtualization.Host", "virtualization.VirtualMachine", "virtualization.VmwareCluster", "virtualization.VmwareDatacenter", "virtualization.VmwareDatastore", "virtualization.VmwareDatastoreCluster", "virtualization.VmwareDistributedNetwork", "virtualization.VmwareDistributedSwitch", "virtualization.VmwareFolder", "virtualization.VmwareHost", "virtualization.VmwareHostGpu", "virtualization.VmwareKernelNetwork", "virtualization.VmwareNetwork", "virtualization.VmwarePhysicalNetworkInterface", "virtualization.VmwareProactiveHa", "virtualization.VmwareUplinkPort", "virtualization.VmwareVcenter", "virtualization.VmwareVirtualDisk", "virtualization.VmwareVirtualMachine", "virtualization.VmwareVirtualMachineGpu", "virtualization.VmwareVirtualMachineSnapshot", "virtualization.VmwareVirtualNetworkInterface", "virtualization.VmwareVirtualSwitch", "vmedia.Policy", "vmedia.PolicyInventory", "vmrc.Console", "vnic.EthAdapterPolicy", "vnic.EthAdapterPolicyInventory", "vnic.EthIf", "vnic.EthIfInventory", "vnic.EthNetworkPolicy", "vnic.EthNetworkPolicyInventory", "vnic.EthQosPolicy", "vnic.EthQosPolicyInventory", "vnic.EthVethInventory", "vnic.EthVnicInventory", "vnic.FcAdapterPolicy", "vnic.FcAdapterPolicyInventory", "vnic.FcIf", "vnic.FcIfInventory", "vnic.FcNetworkPolicy", "vnic.FcNetworkPolicyInventory", "vnic.FcQosPolicy", "vnic.FcQosPolicyInventory", "vnic.FcVethInventory", "vnic.FcVhbaPolicyInventory", "vnic.IscsiAdapterPolicy", "vnic.IscsiAdapterPolicyInventory", "vnic.IscsiBootPolicy", "vnic.IscsiBootPolicyInventory", "vnic.IscsiStaticTargetPolicy", "vnic.IscsiStaticTargetPolicyInventory", "vnic.LanConnectivityPolicy", "vnic.LanConnectivityPolicyInventory", "vnic.LanSettings", "vnic.LcpStatus", "vnic.SanConnectivityPolicy", "vnic.SanConnectivityPolicyInventory", "vnic.SanSettings", "vnic.ScpStatus", "vnic.ServiceEthIf", "vnic.ServiceEthIfInventory", "vnic.VhbaTemplate", "vnic.VifIdPool", "vnic.VnicTemplate", "vrf.Vrf", "webhook.Endpoint", "webhook.Schema", "workflow.AnsibleBatchExecutor", "workflow.BatchApiExecutor", "workflow.Catalog", "workflow.CatalogItemDefinition", "workflow.CatalogServiceRequest", "workflow.CustomDataTypeDefinition", "workflow.ErrorResponseHandler", "workflow.PowerShellBatchApiExecutor", "workflow.RollbackWorkflow", "workflow.ServiceItemActionDefinition", "workflow.ServiceItemActionInstance", "workflow.ServiceItemAttribute", "workflow.ServiceItemDefinition", "workflow.ServiceItemHealthCheckDefinition", "workflow.ServiceItemHealthCheckExecution", "workflow.ServiceItemInstance", "workflow.ServiceItemOutput", "workflow.SshBatchExecutor", "workflow.TaskDebugLog", "workflow.TaskDefinition", "workflow.TaskInfo", "workflow.TaskMetadata", "workflow.TemplateEvaluation", "workflow.TemplateFunctionMeta", "workflow.TemplateParser", "workflow.UiDisplayMetadata", "workflow.Variable", "workflow.WorkflowDefinition", "workflow.WorkflowInfo", "workflow.WorkflowMetadata", "workload.Blueprint", "workload.ClearWorkloadTag", "workload.DeploymentInput", "workload.WorkloadDefinition", "workload.WorkloadDeployment", "workload.WorkloadInstance", "workload.WorkloadMetadata" ], "x-enum-as-string": true }, "Moid": { "description": "The Moid of the referenced REST resource.", "type": "string", "x-omitempty": true }, "Selector": { "description": "An OData $filter expression which describes the REST resource to be referenced. This field may\nbe set instead of 'moid' by clients.\n1. If 'moid' is set this field is ignored.\n1. If 'selector' is set and 'moid' is empty/absent from the request, Intersight determines the Moid of the\nresource matching the filter expression and populates it in the MoRef that is part of the object\ninstance being inserted/updated to fulfill the REST request.\nAn error is returned if the filter matches zero or more than one REST resource.\nAn example filter string is: Serial eq '3AA8B7T11'.", "type": "string", "x-omitempty": true }, "link": { "type": "string", "description": "A URL to an instance of the 'mo.MoRef' class." } } }, "mo.Tag": { "type": "object", "title": "Mo:Tag", "description": "An arbitrary key and value pair that can be used to tag REST resources and organize managed objects by\nassigning meta-data tags to any object.", "properties": { "AncestorDefinitions": { "type": "array", "items": { "description": "The array containing the tag definition references of the ancestors in the object containment hierarchy.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Definition": { "description": "The definition is a reference to the tag definition object.\nThe tag definition object contains the properties of the tag such as name, type, and description.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Key": { "description": "The string representation of a tag key.", "type": "string", "minLength": 1, "maxLength": 356, "x-omitempty": true }, "Propagated": { "description": "Propagated is a boolean flag that indicates whether the tag is propagated to the related managed objects.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SysTag": { "description": "Specifies whether the tag is user-defined or owned by the system.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Type": { "description": "An enum type that defines the type of tag. Supported values are 'pathtag' and 'keyvalue'.\n* `KeyValue` - KeyValue type of tag. Key is required for these tags. Value is optional.\n* `PathTag` - Key contain path information. Value is not present for these tags. The path is created by using the '/' character as a delimiter.For example, if the tag is \"A/B/C\", then \"A\" is the parent tag, \"B\" is the child tag of \"A\" and \"C\" is the child tag of \"B\".", "type": "string", "enum": [ "KeyValue", "PathTag" ], "default": "KeyValue", "readOnly": true, "x-omitempty": true }, "Value": { "description": "The string representation of a tag value.", "type": "string", "minLength": 0, "maxLength": 256, "x-omitempty": true } } }, "mo.VersionContext": { "title": "Mo:Version Context", "description": "VersionContext contains the versioning info for an object.", "x-allOf-name": "mo.VersionContext", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'mo.VersionContext', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "mo.VersionContext" ], "default": "mo.VersionContext", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "mo.VersionContext" ], "default": "mo.VersionContext", "x-enum-as-string": true }, "InterestedMos": { "type": "array", "items": { "description": "A collection of objects that have reference to this versioned object.\nThe lifecycle of the versioned object is based on the interestedMos list;\nthe versioned object will be purged when interestedMos is empty.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MarkedForDeletion": { "description": "The flag to indicate if snapshot is marked for deletion or not. If flag is set then snapshot will be removed after the successful deployment of the policy.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "RefMo": { "description": "A reference to the original Managed Object.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Timestamp": { "description": "The time this versioned Managed Object was created.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the Managed Object, e.g. an incrementing number or a hash id.", "type": "string", "readOnly": true, "x-omitempty": true }, "VersionType": { "description": "Specifies type of version. Currently the only supported value is \"Configured\"\nthat is used to keep track of snapshots of policies and profiles that are intended\nto be configured to target endpoints.\n* `Modified` - Version created every time an object is modified.\n* `Configured` - Version created every time an object is configured to the service profile.\n* `Deployed` - Version created for objects related to a service profile when it is deployed.", "type": "string", "enum": [ "Modified", "Configured", "Deployed" ], "default": "Modified", "readOnly": true, "x-omitempty": true } } } ] }, "monitoring.CategoryStatus": { "title": "Monitoring:Category Status", "description": "Status of an Intersight category such as 'Licensing' with additional details. Several categories and their respective status is reported as part of the health status API.", "x-allOf-name": "monitoring.CategoryStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'monitoring.CategoryStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "monitoring.CategoryStatus" ], "default": "monitoring.CategoryStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "monitoring.CategoryStatus" ], "default": "monitoring.CategoryStatus", "x-enum-as-string": true }, "CategoryLabel": { "description": "Name of the category for which status is being reported (for e.g. 'Licensing', 'Advisories').", "type": "string", "readOnly": true, "x-omitempty": true }, "Deeplink": { "description": "Link to the corresponding category specific page in Intersight to get additional information and troubleshoot. for e.g. 'Alarms' category would have the deeplink as 'https://intersight.com/an/cond/alarms/active'.", "type": "string", "pattern": "^$|^(?:http(s)?:\\/\\/)?[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$", "readOnly": true, "x-omitempty": true }, "Details": { "description": "Additional information regarding category status that may be displayed in UI related to the category status. Optional and currently unused.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceId": { "description": "Additional parameter to be used for traceability and troubleshooting, currently unused.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Aggregated status of the category being reported. For e.g., a given Intersight account might have a combination of high and low severity Advisories applicable to managed devices. However, even if one of the devices is impacted by a high severity Advisories, the category status is reported as 'critical'.\n* `Unknown` - The current status for the respective category cannot be determined. This may be due to some intermittent issue or due to the fact that the user making the request does not have appropriate privileges/entitlements for the concerned category.\n* `Critical` - The Intersight account is impacted by a high severity issue for the applicable category that will need to be addressed immediately. for e.g. critical status for 'Advisories' category would mean that the Intersight account is impacted by an urgent field notice or a vulnerability with high severity level.\n* `Warning` - The Intersight account is impacted by a high severity issue for the applicable category that will need to be addressed soon. for e.g. warning status for 'Advisories' category might mean that the Intersight account is impacted by an a vulnerability with moderate severity level.\n* `Healthy` - The Intersight account is not impacted by any high severity issue for the applicable category.", "type": "string", "enum": [ "Unknown", "Critical", "Warning", "Healthy" ], "default": "Unknown", "readOnly": true, "x-omitempty": true } } } ] }, "monitoring.HealthStatus.Response": { "description": "The response body of a HTTP GET request for the 'monitoring.HealthStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'monitoring.HealthStatus' resources.", "x-one-of-name": "monitoring.HealthStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/monitoring.HealthStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "monitoring.HealthStatus": { "title": "Monitoring:Health Status", "description": "High level, aggregated status of Intersight components for a given Intersight account user. Meant to inform the user if there's an issue with Intersight components that needs her attention. At this point, Aggregated status is reported for 'Licensing', 'Advisories' and 'Alarms' components. Specifically designed to be easily consumed by external dashboards to display an at-a-glance status of Intersight components. This conforms to the health data API schema published as part of Cisco PlatformSuite.", "x-allOf-name": "monitoring.HealthStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'monitoring.HealthStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "monitoring.HealthStatus" ], "default": "monitoring.HealthStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "monitoring.HealthStatus" ], "default": "monitoring.HealthStatus", "x-enum-as-string": true }, "CategoryStatus": { "type": "array", "items": { "description": "List of Intersight categories ('Advisories', 'Licensing', 'Alarms', ...) and their associated statuses with details.", "$ref": "#/components/schemas/monitoring.CategoryStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "HealthDataSchemaVersion": { "description": "Version of compliant health data API schema.", "type": "string", "readOnly": true, "x-omitempty": true }, "Source": { "description": "Set as 'Intersight'. Especially useful in cases such as when this API is consumed by an external dashboard. This field allows such dashboards to aggregate health status across multiple sources (Intersight, Meraki etc.).", "type": "string", "readOnly": true, "x-omitempty": true }, "StatusTimeStamp": { "description": "Time stamp when the status was generated. The status reported by this API may lag the real time status by up to 5 minutes.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/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 } } } ] }, "monitoring.HealthStatus.List": { "title": "List of 'monitoring.HealthStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'monitoring.HealthStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'monitoring.HealthStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/monitoring.HealthStatus" }, "nullable": true } } } ] }, "motemplate.ActionEntry": { "title": "Motemplate:Action Entry", "description": "An action entry that contains the action type and its associated action parameters as a key:value pair.", "x-allOf-name": "motemplate.ActionEntry", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'motemplate.ActionEntry', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "motemplate.ActionEntry" ], "default": "motemplate.ActionEntry", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "motemplate.ActionEntry" ], "default": "motemplate.ActionEntry", "x-enum-as-string": true }, "Params": { "type": "array", "items": { "description": "The collection of action parameters related to the given action type.", "$ref": "#/components/schemas/motemplate.ActionParam", "x-omitempty": true }, "nullable": true }, "Type": { "description": "The action type to be executed.\n* `Sync` - The action to merge values from the template to its derived objects.\n* `Deploy` - The action to execute deploy action on all the objects derived from the template that is mainly applicable for the various profile types.\n* `Detach` - The action to detach the current derived object from its attached template.\n* `Attach` - The action to attach the current object to the specified template.", "type": "string", "enum": [ "Sync", "Deploy", "Detach", "Attach" ], "default": "Sync", "x-omitempty": true } } } ] }, "motemplate.ActionParam": { "title": "Motemplate:Action Param", "description": "An action parameter setting as a key/value pair.", "x-allOf-name": "motemplate.ActionParam", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'motemplate.ActionParam', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "motemplate.ActionParam" ], "default": "motemplate.ActionParam", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "motemplate.ActionParam" ], "default": "motemplate.ActionParam", "x-enum-as-string": true }, "Name": { "description": "The action parameter identifier. The supported values are SyncType and SyncTimer for the template sync action.\n* `None` - The default parameter that implies that no action parameter is required for the template action.\n* `SyncType` - The parameter that describes the type of sync action such as SyncOne or SyncFailed supported on any template or derived object.\n* `SyncTimer` - The parameter for the initial delay in seconds after which the sync action must be executed. The supported range is from 0 to 60 seconds.\n* `OverriddenList` - The parameter applicable in attach operation indicating the configurations that must override the template configurations.", "type": "string", "enum": [ "None", "SyncType", "SyncTimer", "OverriddenList" ], "default": "None", "x-omitempty": true }, "Value": { "description": "The action parameter value is based on the action parameter type. Supported action parameters and their values are-\na) Name - SyncType, Supported Values - SyncFailed, SyncOne.\nb) Name - SyncTimer, Supported Values - 0 to 60 seconds.\nc) Name - OverriddenList, Supported Values - Comma Separated list of overridable configurations.", "type": "string", "x-omitempty": true } } } ] }, "motemplate.SyncError": { "title": "Motemplate:Sync Error", "description": "The configuration error description while syncing a template object to its dervied object.", "x-allOf-name": "motemplate.SyncError", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'motemplate.SyncError', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "motemplate.SyncError" ], "default": "motemplate.SyncError", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "motemplate.SyncError" ], "default": "motemplate.SyncError", "x-enum-as-string": true }, "Message": { "description": "The localized message based on the locale setting of the user's context providing the error description.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The error type that indicates the point of failure.\n* `Transient` - Any error which is a runtime error due to some other action in progress on the derived object that is blocking the sync action. This error type is retriable.For example, when vNIC Template is updated, but the derived vNIC or vNICs are part of a LAN Connectivity policy associated with a profile being deployed to endpoint. In this scenario, the derived vNIC update displays this error.\n* `Validation` - When the template sync on the derived object fails due to an incorrect configuration, it displays a validation error. This error type is considered fatal and not retried.For example, when a new policy is attached to a server profile template, the sync to a derived server profile fails due to the policy attach errors.\n* `User` - Any configuration error due to incorrect or invalid input and that requires user intervention for correction, is displayed under this category. This error type is considered fatal and not retried.For example, when a new policy is attached to a server profile template, the sync to a derived server profile fails. This happens when the policyis not applicable to the server assigned to the server profile, such as the Power policy that is not applicable for UCS Rack servers.\n* `Internal` - Any application internal errors are displayed under this category. This error type is considered fatal and not retried.", "type": "string", "enum": [ "Transient", "Validation", "User", "Internal" ], "default": "Transient", "readOnly": true, "x-omitempty": true } } } ] }, "notification.AbstractAdvisoryFilter": { "title": "Notification:Abstract Advisory Filter", "description": "Filter for a specific advisory type with selected severities and optional CVSS score filtering.", "x-allOf-name": "notification.AbstractAdvisoryFilter", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "notification.AbstractCondition": { "title": "Notification:Abstract Condition", "description": "AbstractCondition is a base abstract class for all types of conditions for notification.Subscription Mo.\nAll conditions types inherit from this base type. It describes the match criteria (condition) for the subscription.\nAbstract type to be used as a condition for notification.Subscription object.\nGives the ability to change add different conditions types in the model without\ndrastic changes to the model itself.", "x-allOf-name": "notification.AbstractCondition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "notification.AbstractMoCondition": { "title": "Notification:Abstract Mo Condition", "description": "This condition type gives the ability to subscribe to the cond.Alarm ObjectType and provide\na list of Severities you're interested in.", "x-allOf-name": "notification.AbstractMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AbstractMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "notification.AdvisoryMoCondition", "notification.AlarmMoCondition", "notification.ApplianceUpgradeMoCondition", "notification.DistributableMoCondition", "notification.MoCondition", "notification.SimpleMoCondition", "notification.SoftwareReleaseMetaMoCondition" ], "x-enum-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": [ "notification.AdvisoryMoCondition", "notification.AlarmMoCondition", "notification.ApplianceUpgradeMoCondition", "notification.DistributableMoCondition", "notification.MoCondition", "notification.SimpleMoCondition", "notification.SoftwareReleaseMetaMoCondition" ], "x-enum-as-string": true }, "Enabled": { "description": "The condition can be switched on/off with out necessity to change the subscription\nsettings: actions, conditions, etc.\nEx.: Subscription MO can be configured, but switched off.", "type": "boolean", "default": true, "x-omitempty": true }, "MoType": { "description": "MoType for which the condition is created.", "type": "string", "x-omitempty": true }, "Operations": { "type": "array", "items": { "description": "The type of change (create, update, delete) performed on the MO.\n* `None` - The 'none' operation/state.Indicates a configuration profile has been deployed, and the desired configuration matches the actual device configuration.\n* `Created` - The 'create' operation/state.Indicates a configuration profile has been created and associated with a device, but the configuration specified in the profilehas not been applied yet. For example, this could happen when the user creates a server profile and has not deployed the profile yet.\n* `Modified` - The 'update' operation/state.Indicates some of the desired configuration changes specified in a profile have not been been applied to the associated device.This happens when the user has made changes to a profile and has not deployed the changes yet, or when the workflow to applythe configuration changes has not completed successfully.\n* `Deleted` - The 'delete' operation/state.Indicates a configuration profile has been been disassociated from a device and the user has not undeployed these changes yet.", "type": "string", "enum": [ "None", "Created", "Modified", "Deleted" ], "default": "None", "x-omitempty": true }, "nullable": true } } } ] }, "notification.AccountSubscription.Response": { "description": "The response body of a HTTP GET request for the 'notification.AccountSubscription' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'notification.AccountSubscription' resources.", "x-one-of-name": "notification.AccountSubscription.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/notification.AccountSubscription.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "notification.AccountSubscription": { "title": "Notification:Account Subscription", "description": "The AccountSubscription object is a crucial component of the Intersight notification framework, designed to facilitate account-level subscriptions managed by Account Administrators. This provides a structured way to handle notifications based on specific events within an account, ensuring administrators can effectively configure and manage subscription settings.\n#### Purpose\nThe AccountSubscription object enables administrators to set up notifications for various account events. It serves as the blueprint for creating, updating, and managing subscriptions, ensuring that notifications are sent according to predefined conditions and actions.\n#### Key Concepts\n- **Account-Level Management:** Designed for account administrators, allowing easy configuration of subscription settings at the account level.\n- **Integration with Notification Methods:** Supports multiple notification methods such as email and webhook to meet diverse requirements.\n- **Conditional Notifications:** Allows definition of conditions that trigger notifications, ensuring only relevant alerts are sent.\n- **Access Control:** Enforces privilege sets so only authorized users can create, update, or delete subscriptions, maintaining security and integrity.\n- **Flexibility and Scalability:** Scales notification features to support complex use cases and evolving business needs.", "x-allOf-name": "notification.AccountSubscription", "allOf": [ { "$ref": "#/components/schemas/notification.Subscription" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AccountSubscription', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.AccountSubscription" ], "default": "notification.AccountSubscription", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.AccountSubscription" ], "default": "notification.AccountSubscription", "x-enum-as-string": true }, "Description": { "description": "The description for the subscription.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_.\\- ]{1,128}$", "x-omitempty": true }, "Name": { "description": "The name of the subscription.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Type": { "description": "The chosen subscription type imposes it is own validation rules.\nWhen 'email' type is chosen, actions array can contain only one entry and it is entry should be of can\nbe only notification.SendEmail; conditions can contain only notification.AlarmMoCondition and condition\ntypes should be unique.\nWhen the 'webhook' type is chosen, the actions array can contain only one entry and it is entry should be of can\nbe only notification.TriggerWebhook; conditions can contain up to a limited amount of entries and all of them\nshould be of type notification.MoCondition.\n* `email` - Email type requires usage of notification.SendEmail complex types for actionsand notification.AlarmMoCondition complex types for conditions.\n* `webhook` - Webhook type requires usage of notification.TriggerWebhook complex types for actionsand notification.MoCondition complex types for conditions.", "type": "string", "enum": [ "email", "webhook" ], "default": "email", "x-createOnly": true, "x-omitempty": true }, "Verify": { "description": "Used to verify the actions of the Subscription MO. For a 'webhook' type Ping event is sent to verify\nthat the webhook server is accessible. For an 'email' type there will be a verification email sent.\n* `none` - No actions will be verified. Default value.\n* `all` - All actions will be re-verified. The previous state of the verification will be preserved.", "type": "string", "enum": [ "none", "all" ], "default": "none", "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Certificate": { "$ref": "#/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." }, "FilterRefs": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "notification.AccountSubscription.List": { "title": "List of 'notification.AccountSubscription' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'notification.AccountSubscription' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'notification.AccountSubscription' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/notification.AccountSubscription" }, "nullable": true } } } ] }, "notification.Action": { "title": "Notification:Action", "description": "Action abstract complex type describes the action the framework should perform when the event matched\nwith a specific subscription is found. Ex.: Send Email, Send Mobile Push, Publish to a specific topic, etc.", "x-allOf-name": "notification.Action", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "notification.AdvisoryMoCondition": { "title": "Notification:Advisory Mo Condition", "description": "This condition type gives the ability to subscribe to the tam.AdvisoryInstance ObjectType and provide\na list of Advisory Types you're interested in.", "x-allOf-name": "notification.AdvisoryMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AdvisoryMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.AdvisoryMoCondition" ], "default": "notification.AdvisoryMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.AdvisoryMoCondition" ], "default": "notification.AdvisoryMoCondition", "x-enum-as-string": true }, "AdvisoryFilters": { "type": "array", "items": { "description": "List of Advisory Types on which user wants to receive notifications.\nThe list of exposed advisory types is Security, Field Notice, and End of Life.", "$ref": "#/components/schemas/notification.AbstractAdvisoryFilter", "x-omitempty": true }, "nullable": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.AggregationSettings": { "title": "Notification:Aggregation Settings", "description": "Settings for events grouping.", "x-allOf-name": "notification.AggregationSettings", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AggregationSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.AggregationSettings" ], "default": "notification.AggregationSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.AggregationSettings" ], "default": "notification.AggregationSettings", "x-enum-as-string": true }, "Enabled": { "description": "Show if aggregation is enabled or not. If aggregation is enabled, events will be grouped and delivered\nas one notification, if it is disabled - each event will be delivered as independent notification.", "type": "boolean", "x-omitempty": true }, "EventsLimit": { "description": "Limit of events in one group. If this limit is reached, a window will be closed regardless of the time limit.", "type": "integer", "format": "int64", "x-omitempty": true }, "Size": { "description": "Time in seconds which means the max time after which the window will be closed.", "type": "string", "x-omitempty": true }, "Step": { "description": "Time in seconds which means how long after the last event Intersight should wait for the next event to come.\nIf there's no new event that matches with the same Subscription within this time, then the window will be closed.", "type": "string", "x-omitempty": true } } } ] }, "notification.AlarmMoCondition": { "title": "Notification:Alarm Mo Condition", "description": "This condition type gives the ability to subscribe to the cond.Alarm ObjectType and provide\na list of Severities you're interested in.", "x-allOf-name": "notification.AlarmMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.AlarmMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.AlarmMoCondition" ], "default": "notification.AlarmMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.AlarmMoCondition" ], "default": "notification.AlarmMoCondition", "x-enum-as-string": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "Severity": { "type": "array", "items": { "description": "List of Severities on which user wants to receive notifications.\nThe list of exposed severities is Info, Critical, Warning.\n* `None` - The Enum value None represents that there is no severity.\n* `Info` - The Enum value Info represents the Informational level of severity.\n* `Critical` - The Enum value Critical represents the Critical level of severity.\n* `Warning` - The Enum value Warning represents the Warning level of severity.\n* `Cleared` - The Enum value Cleared represents that the alarm severity has been cleared.", "type": "string", "enum": [ "None", "Info", "Critical", "Warning", "Cleared" ], "default": "None", "x-omitempty": true }, "nullable": true } } } ] }, "notification.ApplianceUpgradeMoCondition": { "title": "Notification:Appliance Upgrade Mo Condition", "description": "This condition type gives the ability to subscribe to the appliance.Upgrade ObjectType and provide a list of Image statuses you're interested in.", "x-allOf-name": "notification.ApplianceUpgradeMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.ApplianceUpgradeMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.ApplianceUpgradeMoCondition" ], "default": "notification.ApplianceUpgradeMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.ApplianceUpgradeMoCondition" ], "default": "notification.ApplianceUpgradeMoCondition", "x-enum-as-string": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "Statuses": { "type": "array", "items": { "description": "List of Appliance Image Statuses for which user wants to receive notifications.\n* `None` - Default value for ImageStatus enum.\n* `InstallPending` - InstallPending status means the image is downloaded and available for installation on appliance.\n* `InstallComplete` - InstallComplete status means the image installation task has been completed. It includes both success and failure case.", "type": "string", "enum": [ "None", "InstallPending", "InstallComplete" ], "default": "None", "x-omitempty": true }, "nullable": true } } } ] }, "notification.DistributableMoCondition": { "title": "Notification:Distributable Mo Condition", "description": "This condition type gives the ability to subscribe to the software.HyperflexBundleDistributable or firmware.Distributable or appliance.ApplianceDistributable\nor software.HciBundleDistributable ObjectType.", "x-allOf-name": "notification.DistributableMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.DistributableMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.DistributableMoCondition" ], "default": "notification.DistributableMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.DistributableMoCondition" ], "default": "notification.DistributableMoCondition", "x-enum-as-string": true }, "ImageType": { "description": "Image type for which user wants to create notification.\nThe list of valid values for Image type of notification.DistributableMoCondition is software.HyperflexBundleDistributable, software.ApplianceDistributableIntelligence,\nfirmware.Distributable, software.HciBundleDistributable.\n* `None` - Default value for DistributableObjectType enum.\n* `software.ApplianceDistributableIntelligence` - Object type for Appliance Intelligence updates related distributable.\n* `firmware.Distributable` - Object type for firmware related distributable.\n* `software.HyperflexBundleDistributable` - Object type for HyperFlex related distributable.\n* `software.ApplianceDistributableConnected` - Object type for Appliance related distributable. By Choosing this, user shows intent to use the downloaded image for Connected appliance. \n* `software.ApplianceDistributablePrivate` - Object type for Appliance related distributable. By Choosing this, user shows intent to use the downloaded image for Private appliance. \n* `software.UcsdBundleDistributable` - Object type for UCSD related distributable.\n* `software.HciBundleDistributable` - Object type for HCI Bundle related distributable.", "type": "string", "enum": [ "None", "software.ApplianceDistributableIntelligence", "firmware.Distributable", "software.HyperflexBundleDistributable", "software.ApplianceDistributableConnected", "software.ApplianceDistributablePrivate", "software.UcsdBundleDistributable", "software.HciBundleDistributable" ], "default": "None", "x-omitempty": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.EolAdvisoryFilter": { "title": "Notification:Eol Advisory Filter", "description": "Filter for a specific end-of-life advisory with selected severities.", "x-allOf-name": "notification.EolAdvisoryFilter", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractAdvisoryFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.EolAdvisoryFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.EolAdvisoryFilter" ], "default": "notification.EolAdvisoryFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.EolAdvisoryFilter" ], "default": "notification.EolAdvisoryFilter", "x-enum-as-string": true }, "MilestoneType": { "type": "array", "items": { "description": "List of Milestone Types on which user wants to receive notifications.\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 }, "nullable": true } } } ] }, "notification.FieldNoticeAdvisoryFilter": { "title": "Notification:Field Notice Advisory Filter", "description": "Filter for a specific field notice advisory with selected severities.", "x-allOf-name": "notification.FieldNoticeAdvisoryFilter", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractAdvisoryFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.FieldNoticeAdvisoryFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.FieldNoticeAdvisoryFilter" ], "default": "notification.FieldNoticeAdvisoryFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.FieldNoticeAdvisoryFilter" ], "default": "notification.FieldNoticeAdvisoryFilter", "x-enum-as-string": true }, "Severity": { "type": "array", "items": { "description": "List of FnSeverities on which user wants to receive notifications.\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 }, "nullable": true } } } ] }, "notification.HttpHeader": { "title": "Notification:Http Header", "description": "HttpHeader represents a single HTTP header as a name/value pair. Used to specify\ncustom headers that are attached to each webhook notification request.\nExactly one of clearTextValue or encryptedValue must be set. When encrypt is\nfalse, clearTextValue is used. When encrypt is true, encryptedValue is used and\nthe value is stored encrypted and decrypted before being attached to outgoing requests.", "x-allOf-name": "notification.HttpHeader", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.HttpHeader', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.HttpHeader" ], "default": "notification.HttpHeader", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.HttpHeader" ], "default": "notification.HttpHeader", "x-enum-as-string": true }, "ClearTextValue": { "description": "The plaintext value of the HTTP header. Use this field when the header value\nis not sensitive. Used only when encrypt is false.", "type": "string", "x-omitempty": true }, "Encrypt": { "description": "When false (default), clearTextValue is attached to the outgoing request as-is.\nWhen true, encryptedValue is decrypted and attached to the outgoing request.", "type": "boolean", "x-omitempty": true }, "EncryptedValue": { "description": "The sensitive value of the HTTP header, stored encrypted. Use this field when\nthe header value is sensitive, for example an API key or token. Used only when\nencrypt is true. Not returned in GET API responses; use IsEncryptedValueSet to\ncheck whether a value has been set.", "type": "string", "writeOnly": true, "x-omitempty": true }, "IsEncryptedValueSet": { "description": "Indicates whether the value of the 'encryptedValue' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the HTTP header, for example X-Custom-Header.", "type": "string", "x-omitempty": true } } } ] }, "notification.MoCondition": { "title": "Notification:Mo Condition", "description": "This condition type gives the ability to subscribe to arbitrary MO type with arbitrary OData filter string and operation.", "x-allOf-name": "notification.MoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.MoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.MoCondition" ], "default": "notification.MoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.MoCondition" ], "default": "notification.MoCondition", "x-enum-as-string": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "x-omitempty": true } } } ] }, "notification.SecurityAdvisoryFilter": { "title": "Notification:Security Advisory Filter", "description": "Filter for a specific security advisory with selected severities.", "x-allOf-name": "notification.SecurityAdvisoryFilter", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractAdvisoryFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SecurityAdvisoryFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SecurityAdvisoryFilter" ], "default": "notification.SecurityAdvisoryFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SecurityAdvisoryFilter" ], "default": "notification.SecurityAdvisoryFilter", "x-enum-as-string": true }, "Severity": { "type": "array", "items": { "description": "List of Psirt Severities on which user wants to receive notifications.\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 }, "nullable": true } } } ] }, "notification.SendEmail": { "title": "Notification:Send Email", "description": "SendEmail complexType holds the recipient's email address.", "x-allOf-name": "notification.SendEmail", "allOf": [ { "$ref": "#/components/schemas/notification.Action" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SendEmail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SendEmail" ], "default": "notification.SendEmail", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SendEmail" ], "default": "notification.SendEmail", "x-enum-as-string": true }, "Email": { "description": "Email of the recipient, who expects to be notified about the event that happens in Intersight.", "type": "string", "x-omitempty": true } } } ] }, "notification.SimpleFilter": { "title": "Notification:Simple Filter", "description": "Single filter condition with an operator, property, and value.\nUsed by notification SimpleMoCondition when a flat predicate is sufficient (not the shared filterexpr tree).", "x-allOf-name": "notification.SimpleFilter", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SimpleFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SimpleFilter" ], "default": "notification.SimpleFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SimpleFilter" ], "default": "notification.SimpleFilter", "x-enum-as-string": true }, "Operator": { "description": "The operator to apply (eq, ne, contains, in).", "type": "string", "x-omitempty": true }, "Property": { "description": "The property name to filter on (e.g., HostName, Domain,\nServerProfile, Organization).", "type": "string", "x-omitempty": true }, "Value": { "type": "array", "items": { "description": "Values to match the property against. Can be a list of strings.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "notification.SimpleMoCondition": { "title": "Notification:Simple Mo Condition", "description": "This condition type gives the ability to subscribe to arbitrary ObjectType \nwith a controlled list of OData filter string and operation. Primarily used \nfor email subscriptions created by the user or a northbound system.", "x-allOf-name": "notification.SimpleMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SimpleMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SimpleMoCondition" ], "default": "notification.SimpleMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SimpleMoCondition" ], "default": "notification.SimpleMoCondition", "x-enum-as-string": true }, "Filter": { "description": "Simple single-predicate filter. Use either this or filterExpression, not both.\nCriteria that preserves the UI entered filter query.", "$ref": "#/components/schemas/notification.SimpleFilter", "x-omitempty": true }, "FilterExpression": { "description": "Boolean expression of predicates. Use either this or filter, not both.\nWhen set, odataFilter is built by the server from this tree.", "$ref": "#/components/schemas/filterexpr.FilterExpression", "x-omitempty": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.SoftwareReleaseMetaMoCondition": { "title": "Notification:Software Release Meta Mo Condition", "description": "This condition type gives the ability to subscribe to the software.ReleaseMeta ObjectType and provide a list of ImageTypes you're interested in.", "x-allOf-name": "notification.SoftwareReleaseMetaMoCondition", "allOf": [ { "$ref": "#/components/schemas/notification.AbstractMoCondition" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.SoftwareReleaseMetaMoCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.SoftwareReleaseMetaMoCondition" ], "default": "notification.SoftwareReleaseMetaMoCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.SoftwareReleaseMetaMoCondition" ], "default": "notification.SoftwareReleaseMetaMoCondition", "x-enum-as-string": true }, "ImageTypes": { "type": "array", "items": { "description": "List of Image types for which user wants to receive notifications.\nThe list of valid Image types for notification.SoftwareReleaseMetaMoCondition is software.ApplianceDistributableConnected, software.ApplianceDistributablePrivate,\nsoftware.UcsdBundleDistributable.\n* `None` - Default value for DistributableObjectType enum.\n* `software.ApplianceDistributableIntelligence` - Object type for Appliance Intelligence updates related distributable.\n* `firmware.Distributable` - Object type for firmware related distributable.\n* `software.HyperflexBundleDistributable` - Object type for HyperFlex related distributable.\n* `software.ApplianceDistributableConnected` - Object type for Appliance related distributable. By Choosing this, user shows intent to use the downloaded image for Connected appliance. \n* `software.ApplianceDistributablePrivate` - Object type for Appliance related distributable. By Choosing this, user shows intent to use the downloaded image for Private appliance. \n* `software.UcsdBundleDistributable` - Object type for UCSD related distributable.\n* `software.HciBundleDistributable` - Object type for HCI Bundle related distributable.", "type": "string", "enum": [ "None", "software.ApplianceDistributableIntelligence", "firmware.Distributable", "software.HyperflexBundleDistributable", "software.ApplianceDistributableConnected", "software.ApplianceDistributablePrivate", "software.UcsdBundleDistributable", "software.HciBundleDistributable" ], "default": "None", "x-omitempty": true }, "nullable": true }, "OdataFilter": { "description": "Odata filter string managed internally. It is built with specific ObjectType properties.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "notification.Subscription": { "title": "Notification:Subscription", "description": "Subscription is the abstract model that holds shared properties for all subscription types.\nDifferent types of subscriptions extend this model and add their own required properties.", "x-allOf-name": "notification.Subscription", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.Subscription', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "notification.AccountSubscription" ], "default": "notification.AccountSubscription", "x-enum-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": [ "notification.AccountSubscription" ], "default": "notification.AccountSubscription", "x-enum-as-string": true }, "Actions": { "type": "array", "items": { "description": "Notification method that should be used to notify about events that match with a subscription.", "$ref": "#/components/schemas/notification.Action", "x-omitempty": true }, "nullable": true }, "ConditionOperator": { "description": "Operation that binds all the different conditions together.\n* `All` - All is an AND condition applied against the individual conditions.\n* `Any` - Any is an OR condition applied against the individual conditions.", "type": "string", "enum": [ "All", "Any" ], "default": "All", "x-omitempty": true }, "Conditions": { "type": "array", "items": { "description": "Conditions is the array of abstract conditions which should be applied to the event.", "$ref": "#/components/schemas/notification.AbstractCondition", "x-omitempty": true }, "nullable": true }, "Enabled": { "description": "Subscription can be switched on/off without necessity to change the subscription\nsettings: notification methods, conditions, etc.\nEx.: Subscription MO can be configured, but switched off.", "type": "boolean", "x-omitempty": true } } } ] }, "notification.TriggerWebhook": { "title": "Notification:Trigger Webhook", "description": "TriggerWebhook complexType holds the Payload URL's server meta info.\nConfigure at most one primary signing or credential mechanism: secret (HMAC-SHA256),\nauthentication (Basic, Bearer, Splunk), and/or customHeaders (use EncryptedValue\nfor sensitive values such as API keys). Setting both secret and a real\nauthentication credential at the same time is rejected at create/update time.\nIf secret is unset, customHeaders is empty, and authentication is unset or\nasset.NoAuthenticationCredential, deliveries are sent with no HMAC signing and\nno Authorization header (unauthenticated outbound webhook).", "x-allOf-name": "notification.TriggerWebhook", "allOf": [ { "$ref": "#/components/schemas/notification.Action" }, { "type": "object", "description": "Definition of the list of properties defined in 'notification.TriggerWebhook', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "notification.TriggerWebhook" ], "default": "notification.TriggerWebhook", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "notification.TriggerWebhook" ], "default": "notification.TriggerWebhook", "x-enum-as-string": true }, "Authentication": { "description": "The credential used to authenticate webhook delivery requests. When set to a\nreal credential, the appropriate authentication header (Basic, Bearer, or Splunk)\nis attached to each outgoing notification. If not set or if\nasset.NoAuthenticationCredential is used, requests use HMAC-SHA256 via the secret\nfield when secret is set; otherwise the request is sent without Authorization\nsigning or headers.", "$ref": "#/components/schemas/asset.Credential", "x-omitempty": true }, "ClearSecret": { "description": "When set to true on update, the HMAC shared secret is not carried over from the previous\nstored action when the request omits the write-only ``secret`` field. Use this to clear\nthe signing key without re-sending a secret value. When false or not set, the prior\nbehavior applies: the previous secret is preserved on PATCH if ``secret`` is omitted.", "type": "boolean", "default": false, "x-omitempty": true }, "CustomHeaders": { "type": "array", "items": { "description": "List of additional HTTP headers to attach to each webhook notification request.\nThese headers are sent in addition to any headers set by the authentication\ncredential. Each entry must have a unique header name.", "$ref": "#/components/schemas/notification.HttpHeader", "x-omitempty": true }, "maxItems": 10, "nullable": true }, "FirstFailedRequest": { "description": "Holds the timestamp of the first failed request. The first time the notification is not delivered to the\nwebhook server, the user will have the Warning alarm in the system. Next 48 hours the system still will try\nto notify the webhook server. If after 48 hours the server is not recovered, the system will mark this\nwebhook as Inactive, and the user will have a critical alarm in the system.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "IsSecretSet": { "description": "Indicates whether the value of the 'secret' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "LastNetworkError": { "description": "Holds the error message for the user of the last response.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastResponseCode": { "description": "Holds the code of the last response, which helps to debug the issue in case if webhook server is not reachable.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Secret": { "description": "Prefer the Authentication property to configure how webhook deliveries are authenticated, including the Authorization header.\nThis field holds the shared secret used for HMAC-SHA256 signing when no credential is configured, and remains supported for existing integrations.\nBy this header developers of the webhooks servers can make sure that events are received from the trusted source - Intersight.", "type": "string", "writeOnly": true, "x-omitempty": true }, "State": { "description": "State of the action shows whether this action passes the verification or not. If this property holds\n'Inactive' value, this action will not be executed. To verify action again, use the Verify property from the MO.\n* `Inactive` - Inactive state means action didn't pass the verification and it won't be executed.\n* `Active` - Active state means that action successfully passed the verification and it is ready to be performed.", "type": "string", "enum": [ "Inactive", "Active" ], "default": "Inactive", "readOnly": true, "x-omitempty": true }, "Url": { "description": "Payload URL of the recipient app, which is intended to serve the events that happens in Intersight.", "type": "string", "pattern": "^https:\\/\\/[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$", "x-omitempty": true } } } ] }, "oauth.AccessToken.Response": { "description": "The response body of a HTTP GET request for the 'oauth.AccessToken' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'oauth.AccessToken' resources.", "x-one-of-name": "oauth.AccessToken.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/oauth.AccessToken.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "oauth.AccessToken.Relationship": { "description": "A relationship to the 'oauth.AccessToken' resource, or the expanded 'oauth.AccessToken' resource, or the 'null' value.", "x-one-of-name": "oauth.AccessToken.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/oauth.AccessToken" } ], "discriminator": { "propertyName": "ClassId" } }, "oauth.AccessToken": { "title": "Oauth:Access Token", "description": "The AccessToken object is a key component of the OAuth-based authentication system, designed to manage API access tokens associated with user accounts. This provides a secure mechanism for applications to access services on behalf of users, ensuring that permissions and access controls are upheld.\n#### Purpose\nThe AccessToken object serves as a secure representation of authorization for specific applications to interact with designated services. It supports seamless and efficient access management while maintaining strict security protocols.\n#### Key Concepts\n- **Authorization Management:** Represents the OAuth access token, which embodies the permissions granted to a specific application for accessing a service.\n- **Security:** Ensures that access tokens are securely issued and managed, with support for refresh tokens to prolong access without user intervention.\n- **Access Control:** The AccessToken object supports privilege sets to ensure that only authorized administrators can read or delete access tokens.\n- **Relationship Handling:** Linked to the iam.Account object, representing the account responsible for managing the OAuth process.", "x-allOf-name": "oauth.AccessToken", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'oauth.AccessToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oauth.AccessToken" ], "default": "oauth.AccessToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oauth.AccessToken" ], "default": "oauth.AccessToken", "x-enum-as-string": true }, "ApiType": { "description": "OAuth API type (e.g., Smart licensing API).\n* `Unknown` - Unknown serves as the default API type.\n* `SmartLicensing-API` - Smart licensing API type.\n* `CommerceEstimate-API` - Commerce Estimate API type.", "type": "string", "enum": [ "Unknown", "SmartLicensing-API", "CommerceEstimate-API" ], "default": "Unknown", "x-createOnly": true, "x-omitempty": true }, "Expiry": { "description": "Access token expiration date and time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Issuer": { "description": "OAuth access token issuer.", "type": "string", "readOnly": true, "x-omitempty": true }, "RefreshExpiry": { "description": "Refresh token expiration date and time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "TokenOwner": { "description": "MOID of the access token owner.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "oauth.AccessToken.List": { "title": "List of 'oauth.AccessToken' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'oauth.AccessToken' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'oauth.AccessToken' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/oauth.AccessToken" }, "nullable": true } } } ] }, "oauth.Authorization.Response": { "description": "The response body of a HTTP GET request for the 'oauth.Authorization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'oauth.Authorization' resources.", "x-one-of-name": "oauth.Authorization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/oauth.Authorization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "oauth.Authorization": { "title": "Oauth:Authorization", "description": "The Authorization object underpins the OAuth2 authorization process, enabling user consent for external interactions on behalf of their account. It supports secure and efficient management of user credentials for accessing external services.\n#### Purpose\nAuthorization serves as the conduit for user consent, allowing Intersight to interact with external software repositories securely on behalf of users, particularly in support of OAuth2 resource owner grant types.\n#### Key Concepts\n- **User Consent:** Facilitates secure consent mechanisms for external interactions, ensuring user credentials are protected.\n- **Security Measures:** Incorporates encryption and secure handling of user credentials, safeguarding access and interactions.\n- **Privileged Access:** Ensures that only authorized administrators can create, update, or read authorizations, maintaining strict access controls.\n- **Account Integration:** Associated with the iam.Account object, providing a structured approach to managing user authorization processes.", "x-allOf-name": "oauth.Authorization", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'oauth.Authorization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oauth.Authorization" ], "default": "oauth.Authorization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oauth.Authorization" ], "default": "oauth.Authorization", "x-enum-as-string": true }, "ApiType": { "description": "OAuth API type (e.g., Smart licensing API).\n* `Unknown` - Unknown serves as the default API type.\n* `SmartLicensing-API` - Smart licensing API type.\n* `CommerceEstimate-API` - Commerce Estimate API type.", "type": "string", "enum": [ "Unknown", "SmartLicensing-API", "CommerceEstimate-API" ], "default": "Unknown", "writeOnly": true, "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 }, "IsUserIdSet": { "description": "Indicates whether the value of the 'userId' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "Password used by Intersight to create OAuth2 tokens for interacting with the external repository on behalf of the user account.", "type": "string", "writeOnly": true, "x-omitempty": true }, "UserId": { "description": "Username used by Intersight to create OAuth2 tokens for interacting with the external repository on behalf of the user account.", "type": "string", "writeOnly": true, "x-omitempty": true }, "AccessToken": { "$ref": "#/components/schemas/oauth.AccessToken.Relationship", "description": "A reference to a oauthAccessToken resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Account": { "$ref": "#/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 } } } ] }, "oauth.Authorization.List": { "title": "List of 'oauth.Authorization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'oauth.Authorization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'oauth.Authorization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/oauth.Authorization" }, "nullable": true } } } ] }, "onprem.ApplianceSystemInfo.Response": { "description": "The response body of a HTTP GET request for the 'onprem.ApplianceSystemInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'onprem.ApplianceSystemInfo' resources.", "x-one-of-name": "onprem.ApplianceSystemInfo.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/onprem.ApplianceSystemInfo.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "onprem.ApplianceSystemInfo": { "title": "Onprem:Appliance System Info", "description": "ApplianceSystemInfo managed object stores the Intersight Appliance System information.\nIt is created during the Intersight Appliance setup. It is updated periodically with current system information and it is applicable only for Cisco Assist deployment currently.", "x-allOf-name": "onprem.ApplianceSystemInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.ApplianceSystemInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.ApplianceSystemInfo" ], "default": "onprem.ApplianceSystemInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.ApplianceSystemInfo" ], "default": "onprem.ApplianceSystemInfo", "x-enum-as-string": true }, "DeploymentSize": { "description": "Current running deployment size for the Intersight Appliance node. Eg. tiny, small, medium, large etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Hostname": { "description": "Cluster node's FQDN or IP address.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeId": { "description": "System assigned unique ID of the Intersight Appliance node. The system incrementally assigns identifiers to each node in the Intersight Appliance cluster starting with a value of 1.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NodeIpV4Config": { "description": "IPv4 subnet and gateway configuration of the Intersight Appliance node.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.IpV4Interface", "readOnly": true, "x-omitempty": true }, "NodeIpV6Config": { "description": "IPv6 subnet and gateway configuration of the Intersight Appliance node.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.IpV6Interface", "readOnly": true, "x-omitempty": true }, "NodeType": { "description": "The node type of Intersight Virtual Appliance.\n* `standalone` - Single Node Intersight Virtual Appliance.\n* `management` - Management node type when Intersight Virtual Appliance is running as management-worker deployment.\n* `hamanagement` - Management node type when Intersight Virtual Appliance is running as multi node HA deployment.\n* `metrics` - Metrics node when Intersight Virtual Appliance is running management-metrics node.", "type": "string", "enum": [ "standalone", "management", "hamanagement", "metrics" ], "default": "standalone", "readOnly": true, "x-omitempty": true }, "OperationalStatus": { "description": "Operational status of the Intersight Appliance node.\n* `Unknown` - The status of the appliance node is unknown.\n* `Operational` - The appliance node is operational.\n* `Impaired` - The appliance node is impaired.\n* `AttentionNeeded` - The appliance node needs attention.\n* `ReadyToJoin` - The node is ready to be added to a standalone Intersight Appliance to form a cluster.\n* `OutOfService` - The user has taken this node (part of a cluster) to out of service.\n* `ReadyForReplacement` - The cluster node is ready to be replaced.\n* `ReplacementInProgress` - The cluster node replacement is in progress.\n* `ReplacementFailed` - There was a failure during the cluster node replacement.\n* `WorkerNodeInstInProgress` - The worker node installation is in progress.\n* `WorkerNodeInstSuccess` - The worker node installation succeeded.\n* `WorkerNodeInstFailed` - The worker node installation failed.", "type": "string", "enum": [ "Unknown", "Operational", "Impaired", "AttentionNeeded", "ReadyToJoin", "OutOfService", "ReadyForReplacement", "ReplacementInProgress", "ReplacementFailed", "WorkerNodeInstInProgress", "WorkerNodeInstSuccess", "WorkerNodeInstFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "SerialId": { "description": "SerialId of the Intersight Appliance. SerialId is generated when the Intersight Appliance is setup. It is a unique UUID string, and serialId will not change for the life time of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Current software running version of the Intersight Appliance.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "onprem.ApplianceSystemInfo.List": { "title": "List of 'onprem.ApplianceSystemInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'onprem.ApplianceSystemInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'onprem.ApplianceSystemInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/onprem.ApplianceSystemInfo" }, "nullable": true } } } ] }, "onprem.AuditRecord.Response": { "description": "The response body of a HTTP GET request for the 'onprem.AuditRecord' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'onprem.AuditRecord' resources.", "x-one-of-name": "onprem.AuditRecord.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/onprem.AuditRecord.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "onprem.AuditRecord": { "title": "Onprem:Audit Record", "description": "AuditRecord presents the configuration changes made by the user per transaction.", "x-allOf-name": "onprem.AuditRecord", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.AuditRecord', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.AuditRecord" ], "default": "onprem.AuditRecord", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.AuditRecord" ], "default": "onprem.AuditRecord", "x-enum-as-string": true }, "Event": { "description": "The type of event that occurred. Possible values are \"Login\", \"Logout\", \"Created\", \"Modified\", \"Deleted\".", "type": "string", "readOnly": true, "x-omitempty": true }, "HttpOperation": { "description": "It contains the http request type and URL for the operation. In case of authentication request, this field \"POST /iam/adminlogin\".", "type": "string", "readOnly": true, "x-omitempty": true }, "HttpResponseCode": { "description": "The response code of the operation. If the operation is successful, this field will be 200.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HttpResponsePayload": { "description": "The body of the REST response that was sent to the client, represented as a JSON document.", "nullable": true, "readOnly": true, "x-omitempty": true }, "MoType": { "description": "The object type of the REST resource that was created, modified or deleted.", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectMoid": { "description": "The Moid of the REST resource that was created, modified or deleted.", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectName": { "description": "The Name of the REST resource on which the operation was performed.", "nullable": true, "readOnly": true, "x-omitempty": true }, "Request": { "description": "The body of the REST request that was received from a client to create or modify a REST resource, represented as a JSON document.", "nullable": true, "readOnly": true, "x-omitempty": true }, "SessionId": { "description": "The sessionId in which the user made the change. In case that the session is later deleted, we still have some reference to the information.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceIp": { "description": "The source IP of the client where the user action was performed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Timestamp": { "description": "The timestamp of the user action performed.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "TraceId": { "description": "The trace id of the request that was used to create, modify or delete a REST resource.\nA trace id is a unique identifier for one particular REST request. It may be used for troubleshooting purpose\nby the Intersight technical support team.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserAgentString": { "description": "The raw, string representation of the user agent of the request from the user-agent http request header.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserIdOrEmail": { "description": "The userId or the email of the associated user that made the change. In case that user is later deleted, we still have some reference to the information.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "onprem.AuditRecord.List": { "title": "List of 'onprem.AuditRecord' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'onprem.AuditRecord' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'onprem.AuditRecord' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/onprem.AuditRecord" }, "nullable": true } } } ] }, "onprem.ClusterInfo": { "title": "Onprem:Cluster Info", "description": "ClusterInfo encapsulates properties of an Intersight Appliance. ClusterNode and\nClusterInfo data structures are shared between the upgrade services running in\nthe Intersight and the Intersight Appliance.", "x-allOf-name": "onprem.ClusterInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.ClusterInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.ClusterInfo" ], "default": "onprem.ClusterInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.ClusterInfo" ], "default": "onprem.ClusterInfo", "x-enum-as-string": true }, "Nodes": { "type": "array", "items": { "description": "Collection of all nodes participating in the Intersight Appliance cluster.", "$ref": "#/components/schemas/onprem.ClusterNode", "readOnly": true, "x-omitempty": true }, "nullable": true }, "QuorumOk": { "description": "Indicates if the cluster quorum requirement is met. This field has a value of 'true' when at least (n + 1) / 2 number of nodes are up and running.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ReportedTime": { "description": "Date on which the cluster information was collected and reported.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "SetupTime": { "description": "Initial setup date and time of the Intersight Appliance.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "TimeZone": { "description": "Timezone of the Intersight Appliance. The default value is in UTC.\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 } } } ] }, "onprem.ClusterNode": { "title": "Onprem:Cluster Node", "description": "ClusterNode encapsulates the properties of an Intersight Appliance node (virtual machine).\nClusterNode and ClusterInfo data structures are shared between the upgrade services running\nin the Intersight and the Intersight Appliance.", "x-allOf-name": "onprem.ClusterNode", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.ClusterNode', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.ClusterNode" ], "default": "onprem.ClusterNode", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.ClusterNode" ], "default": "onprem.ClusterNode", "x-enum-as-string": true }, "BootTime": { "description": "Start time of the device connector in the Intersight Appliance node.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ClusterMode": { "description": "Mode of the appliance cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "CpuCount": { "description": "Number of CPUs configured for the Intersight Appliance node.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DeploymentType": { "description": "Deployment type of the Intersight Appliance node.", "type": "string", "readOnly": true, "x-omitempty": true }, "Disks": { "type": "array", "items": { "description": "Disk usage information for the Intersight Appliance node.", "$ref": "#/components/schemas/onprem.ResourceInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Hostname": { "description": "The hostname or FQDN of the Intersight Appliance node.", "type": "string", "readOnly": true, "x-omitempty": true }, "Memory": { "description": "Memory usage information for the Intersight Appliance node.", "$ref": "#/components/schemas/onprem.ResourceInfo", "readOnly": true, "x-omitempty": true }, "NodeId": { "description": "Identifier of the Intersight Appliance node (one based).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PingErrorNodes": { "type": "array", "items": { "description": "Host names of the nodes that are unreachable from this node.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PingOk": { "description": "Indicates if the node can ping other nodes in the Intersight Appliance cluster. The Ping operation is a high level application specific status check operation, not an ICMP ping between the hosts.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "PrimaryNode": { "description": "Indicates if this node is the primary node.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "RsyncErrorNodes": { "type": "array", "items": { "description": "Host names of the nodes that are unreachable by rsync from this node.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RsyncOk": { "description": "Indicates if this node can rsync to other nodes.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Current version of the device connector in the Intersight Appliance node.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualEnvType": { "description": "Virtual Env type of the Intersight Appliance node (ESXi, Hyper-V or KVM).", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "onprem.ImagePackage": { "title": "Onprem:Image Package", "description": "ImagePackage encapsulates a software image package. ImagePackage can be\na docker image, a UI web image, an endpoint (e.g. UCSM) image, a device\nconnector image or an ansible scripts package.", "x-allOf-name": "onprem.ImagePackage", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.ImagePackage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.ImagePackage" ], "default": "onprem.ImagePackage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.ImagePackage" ], "default": "onprem.ImagePackage", "x-enum-as-string": true }, "FilePath": { "description": "Optional file path of the image package.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileSha": { "description": "Image file's fingerprint. Fingerprint is calculated using SHA256 algorithm.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileSize": { "description": "Image file size in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FileTime": { "description": "Image file's last modified date and time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Filename": { "description": "Filename of the image package.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the software image package.", "type": "string", "readOnly": true, "x-omitempty": true }, "PackageType": { "description": "Image package type (e.g. service, system etc.).", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Image package version string.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "onprem.ResourceInfo": { "title": "Onprem:Resource Info", "description": "Common data structure used for capturing memory or storage usage information.", "x-allOf-name": "onprem.ResourceInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.ResourceInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.ResourceInfo" ], "default": "onprem.ResourceInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.ResourceInfo" ], "default": "onprem.ResourceInfo", "x-enum-as-string": true }, "Avail": { "description": "Available memory or storage in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the resource. In case of disk, it is the mount name of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "Total": { "description": "Total memory or storage in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "onprem.Schedule": { "title": "Onprem:Schedule", "description": "Schedule is used by Intersight Appliance services to store task scheduling information.\nFor example, appliance backup service uses Schedule to store the backup schedule of the\nIntersight Appliance. The Upgrade service uses Schedule to store the user-defined schedule\nfor software upgrades of the Intersight Appliance.", "x-allOf-name": "onprem.Schedule", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.Schedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.Schedule" ], "default": "onprem.Schedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.Schedule" ], "default": "onprem.Schedule", "x-enum-as-string": true }, "DayOfMonth": { "description": "Schedule a task on a specific day of the month. Valid values are 1 through 31. If monthOfYear is specified, then dayOfMonth value must be valid for that month. DayOfMonth may not be set when dayOfWeek is specfied.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 31, "x-omitempty": true }, "DayOfWeek": { "description": "Schedule a task on a specific day of the week. Valid values are 1 through 7, with 1 being Sunday. DayOfWeek may not be specfied when dayOfMonth is specified.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 7, "x-omitempty": true }, "MonthOfYear": { "description": "Schedule a task on a specific month of the year. Valid values are 1 through 12, with 1 being January.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 12, "x-omitempty": true }, "RepeatInterval": { "description": "Schedule a task to run periodically at an interval. Default unit of the RepeatInterval is in minutes. If the RepeateInterval value is set, then all other properties are ignored by the scheduler. RepeateInterval constraints are enforced by the services that use the schedule. Each service has pre-configured service specific properties for enforcing minimum and maximum values of the RepeatInterval.", "type": "integer", "format": "int64", "x-omitempty": true }, "TimeOfDay": { "description": "Time of the day in seconds. TimeOfDay is required for all schedule configurations, except when the RepeateInterval field is specified.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 86399, "x-omitempty": true }, "TimeZone": { "description": "Timezone to use for the schedule calculation. If a timezone value is not speficied, then the schedule calculation will be based on UTC.\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 }, "WeekOfMonth": { "description": "Schedule a task on a specific week of the month. Valid values are 1 through 5. Value of 5 means last week of the month. WeekOfMonth may not be set when dayOfMonth is specified.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 5, "x-omitempty": true } } } ] }, "onprem.Upgrade.Response": { "description": "The response body of a HTTP GET request for the 'onprem.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 'onprem.Upgrade' resources.", "x-one-of-name": "onprem.Upgrade.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/onprem.Upgrade.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "onprem.Upgrade": { "title": "Onprem:Upgrade", "description": "Upgrade tracks the Intersight Appliance's software upgrades. Intersight Appliance's\nupgrade service automatically creates an Upgrade managed object when there is a\npending software upgrade. User may modify an active Upgrade managed object to reset\nthe software upgrade start time. However, user may not be able to postpone an upgrade\nbeyond the limit enforced by the upgrade grace period set in the software manifest.", "x-allOf-name": "onprem.Upgrade", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.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": [ "onprem.Upgrade" ], "default": "onprem.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": [ "onprem.Upgrade" ], "default": "onprem.Upgrade", "x-enum-as-string": true }, "Active": { "description": "Indicates if the software upgrade is active or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "AllNodesPingable": { "description": "Flag to indicate if all the nodes in the cluster are pingable. It is used to determine if the upgrade can be started.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "CompletedPhases": { "type": "array", "items": { "description": "Collection of the completed software upgrade phases.", "$ref": "#/components/schemas/onprem.UpgradePhase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "CurrentPhase": { "description": "Current phase of the Intersight Appliance's software upgrade.", "$ref": "#/components/schemas/onprem.UpgradePhase", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Description of the software upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date of the software upgrade.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ErrorCode": { "description": "Error code for Intersight Appliance's software upgrade. In case of failure - this code will help decide if software upgrade can be retried.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Fingerprint": { "description": "Software upgrade manifest's fingerprint.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsPatch": { "description": "Flag to indicate if the software upgrade is a patch upgrade.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsRollingBack": { "description": "Track if software upgrade is upgrading or rolling back.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsUserTriggered": { "description": "Indicates if the upgrade is triggered by user or due to schedule.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the upgrade. The name is auto-generated by the system when the upgrade is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "Progress": { "description": "Progress of the software upgrade. It is a percentage value between 0 and 100.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RollbackNeeded": { "description": "Track if rollback is needed.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "RollbackStatus": { "description": "Status of the Intersight Appliance's software rollback status.", "type": "string", "readOnly": true, "x-omitempty": true }, "ScheduledTime": { "description": "It is the time when the upgrade will be started. It is calculated based on the upgrade grace period and the current time. It is a system generated field and cannot be modified by the user. User cannot postpone the upgrade beyond the scheduled time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "Start date of the software upgrade. UI can modify startTime to re-schedule an upgrade.", "type": "string", "format": "date-time", "x-omitempty": true }, "Status": { "description": "Status of the Intersight Appliance's software upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpgradeGracePeriod": { "description": "Grace period in seconds before the automatic upgrade is initiated. The upgrade service uses the grace period to compute the upgrade start time when it receives an upgrade notfication from the Intersight. If there is an Upgrade Policy configured for the Intersight Appliance, then the upgrade service uses the policy to compute the upgrade start time. However, the upgrade start time cannot not exceed the limit enforced by the grace period.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UpgradeImpactDuration": { "description": "Duration (in minutes) for which services will be disrupted.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "UpgradeImpactEnum": { "description": "UpgradeImpactEnum is used to indicate the kind of impact the upgrade has on currently running services on the appliance.\n* `None` - The upgrade has no effect on the system.\n* `Disruptive` - The services will not be functional during the upgrade.\n* `Disruptive-reboot` - The upgrade needs a reboot.", "type": "string", "enum": [ "None", "Disruptive", "Disruptive-reboot" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Software upgrade manifest's version.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "onprem.Upgrade.List": { "title": "List of 'onprem.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'onprem.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 'onprem.Upgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/onprem.Upgrade" }, "nullable": true } } } ] }, "onprem.UpgradeNote": { "title": "Onprem:Upgrade Note", "description": "UpgradeNote managed object contains the description of one feature/bug fix.", "x-allOf-name": "onprem.UpgradeNote", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.UpgradeNote', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.UpgradeNote" ], "default": "onprem.UpgradeNote", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.UpgradeNote" ], "default": "onprem.UpgradeNote", "x-enum-as-string": true }, "Message": { "description": "The change description, such as explanations of a new feature or defect resolution.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "onprem.UpgradePhase": { "title": "Onprem:Upgrade Phase", "description": "UpgradePhase represents a phase of the Intersight Appliance software upgrade\nprocess. This data structure is shared by both the Intersight upgrade service\nand the Intersight Appliance's upgrade service.", "x-allOf-name": "onprem.UpgradePhase", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.UpgradePhase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.UpgradePhase" ], "default": "onprem.UpgradePhase", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.UpgradePhase" ], "default": "onprem.UpgradePhase", "x-enum-as-string": true }, "CurrentNode": { "description": "Id of the node the upgrade phase is running on.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CurrentNodeHostname": { "description": "Hostname of the node the upgrade phase is running on.", "type": "string", "readOnly": true, "x-omitempty": true }, "ElapsedTime": { "description": "Elapsed time in seconds to complete the current upgrade phase.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "End date of the software upgrade phase.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Failed": { "description": "Indicates if the upgrade phase has failed or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Message": { "description": "Status message set during the upgrade phase.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the upgrade phase.\n* `init` - Upgrade service initialization phase.\n* `CheckCluster` - For a multinode system, check that all nodes in the cluster are connected and running.\n* `monitor` - Monitor a required upgrade.\n* `UpdateAnsibleHosts` - Update the ansible hosts file with latest template.\n* `SyncImages` - For a multinode system, sync image files between nodes.\n* `Prepare` - Upgrade service prepares folders and templated files.\n* `ServiceLoad` - Upgrade service loads the service images into the local docker cache.\n* `UiLoad` - Upgrade service loads the UI packages into the local cache.\n* `GenerateConfig` - Upgrade service generates the Kubernetes configuration files.\n* `DeployService` - Upgrade service deploys the Kubernetes services.\n* `UpgradeOS` - Run /opt/cisco/bin/onprem-upgrade-start.sh for each node.\n* `UpgradeServices` - Run /opt/cisco/bin/onprem-upgrade-start.sh per node.\n* `VerifyPlaybookSuccess` - Verify the upgrade playbook for UpgradeOS or UpgradeServices completed successfully.\n* `FinishUpgrade` - Run /opt/cisco/bin/onprem-upgrade-finish.sh for each node.\n* `Success` - Upgrade completed successfully.\n* `Fail` - Indicates that the upgrade process has failed.\n* `Cancel` - Indicates that the upgrade was canceled by the Intersight Appliance.\n* `Telemetry` - Upgrade service sends basic telemetry data to the Intersight.", "type": "string", "enum": [ "init", "CheckCluster", "monitor", "UpdateAnsibleHosts", "SyncImages", "Prepare", "ServiceLoad", "UiLoad", "GenerateConfig", "DeployService", "UpgradeOS", "UpgradeServices", "VerifyPlaybookSuccess", "FinishUpgrade", "Success", "Fail", "Cancel", "Telemetry" ], "default": "init", "readOnly": true, "x-omitempty": true }, "RetryCount": { "description": "Retry count of the upgrade phase.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "Start date of the software upgrade phase.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the upgrade phase.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "onprem.UserPreference.Response": { "description": "The response body of a HTTP GET request for the 'onprem.UserPreference' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'onprem.UserPreference' resources.", "x-one-of-name": "onprem.UserPreference.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/onprem.UserPreference.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "onprem.UserPreference": { "title": "Onprem:User Preference", "description": "Holder for UI preferences such as theme, columns.", "x-allOf-name": "onprem.UserPreference", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'onprem.UserPreference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "onprem.UserPreference" ], "default": "onprem.UserPreference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "onprem.UserPreference" ], "default": "onprem.UserPreference", "x-enum-as-string": true }, "Preference": { "description": "UI preferences of the user.", "nullable": true, "x-omitempty": true } } } ] }, "onprem.UserPreference.List": { "title": "List of 'onprem.UserPreference' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'onprem.UserPreference' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'onprem.UserPreference' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/onprem.UserPreference" }, "nullable": true } } } ] }, "openapi.ApiInfo": { "title": "Openapi:Api Info", "description": "Meta information about the API that will be generated as task.", "x-allOf-name": "openapi.ApiInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.ApiInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.ApiInfo" ], "default": "openapi.ApiInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.ApiInfo" ], "default": "openapi.ApiInfo", "x-enum-as-string": true }, "ApiPathObjectIdentifier": { "description": "Unique identifier for the ApiMethod object that holds more information about this API.", "$ref": "#/components/schemas/mo.MoRef", "x-omitempty": true }, "Description": { "description": "A detailed description of the API.", "type": "string", "x-omitempty": true }, "DisplayLabel": { "description": "Display name of the selected API endpoint.", "type": "string", "x-omitempty": true }, "Method": { "description": "Method Type of the selected API.\n* `GET` - Method type which indicates it is a GET API call.\n* `POST` - Method type which indicates it is a POST API call.\n* `PUT` - Method type which indicates it is a PUT API call.\n* `PATCH` - Method type which indicates it is a PATCH API call.\n* `DELETE` - Method type which indicates it is a DELETE API call.", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "default": "GET", "x-omitempty": true }, "Name": { "description": "Name of the selected API endpoint.", "type": "string", "x-omitempty": true }, "Path": { "description": "API Path of the selected API endpoint.", "type": "string", "x-omitempty": true }, "ValidationError": { "description": "Validation error messages will be captured by this property.", "type": "string", "readOnly": true, "x-omitempty": true }, "ValidationStatus": { "description": "Validation Status of selected API that indicates if the API validation passed or failed.\n* `none` - Indicates the default status.\n* `Success` - Denotes that the validation is successful.\n* `Failed` - Denotes that the validation failed. Validation could fail if information present in the OpenAPI specification is incomplete or missing.", "type": "string", "enum": [ "none", "Success", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true } } } ] }, "openapi.ApiMethodMeta.Response": { "description": "The response body of a HTTP GET request for the 'openapi.ApiMethodMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.ApiMethodMeta' resources.", "x-one-of-name": "openapi.ApiMethodMeta.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.ApiMethodMeta.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.ApiMethodMeta": { "title": "Openapi:Api Method Meta", "description": "Contains metadata about APIs in the previously uploaded OpenAPI specification file.", "x-allOf-name": "openapi.ApiMethodMeta", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.ApiMethodMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.ApiMethodMeta" ], "default": "openapi.ApiMethodMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.ApiMethodMeta" ], "default": "openapi.ApiMethodMeta", "x-enum-as-string": true }, "Description": { "description": "The description of the given API.", "type": "string", "readOnly": true, "x-omitempty": true }, "DisplayLabel": { "description": "The display label of the given API.", "type": "string", "readOnly": true, "x-omitempty": true }, "Method": { "description": "The method type for the given API.\n* `GET` - Method type which indicates it is a GET API call.\n* `POST` - Method type which indicates it is a POST API call.\n* `PUT` - Method type which indicates it is a PUT API call.\n* `PATCH` - Method type which indicates it is a PATCH API call.\n* `DELETE` - Method type which indicates it is a DELETE API call.", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "default": "GET", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The description of the given API.", "type": "string", "readOnly": true, "x-omitempty": true }, "Path": { "description": "Path of the selected API endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "Source": { "$ref": "#/components/schemas/openapi.ProcessFile.Relationship", "description": "A reference to a openapiProcessFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "openapi.ApiMethodMeta.List": { "title": "List of 'openapi.ApiMethodMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.ApiMethodMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.ApiMethodMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.ApiMethodMeta" }, "nullable": true } } } ] }, "openapi.FailedTask": { "title": "Openapi:Failed Task", "description": "A type that holds information about failed tasks.", "x-allOf-name": "openapi.FailedTask", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.FailedTask', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.FailedTask" ], "default": "openapi.FailedTask", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.FailedTask" ], "default": "openapi.FailedTask", "x-enum-as-string": true }, "Name": { "description": "Name of the task.", "type": "string", "x-omitempty": true }, "Path": { "description": "REST API path of the task.", "type": "string", "x-omitempty": true }, "Reason": { "description": "Indicates the reason for task creation failure.", "type": "string", "x-omitempty": true } } } ] }, "openapi.KeyValuePair": { "title": "Openapi:Key Value Pair", "description": "A key, value pair to hold different types of key, value information.", "x-allOf-name": "openapi.KeyValuePair", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.KeyValuePair', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.KeyValuePair" ], "default": "openapi.KeyValuePair", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.KeyValuePair" ], "default": "openapi.KeyValuePair", "x-enum-as-string": true }, "Key": { "description": "Name of the key variable.", "type": "string", "x-omitempty": true }, "Value": { "description": "Value of the key variable.", "type": "string", "x-omitempty": true } } } ] }, "openapi.OpenApiSpecification.Response": { "description": "The response body of a HTTP GET request for the 'openapi.OpenApiSpecification' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.OpenApiSpecification' resources.", "x-one-of-name": "openapi.OpenApiSpecification.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.OpenApiSpecification.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.OpenApiSpecification.Relationship": { "description": "A relationship to the 'openapi.OpenApiSpecification' resource, or the expanded 'openapi.OpenApiSpecification' resource, or the 'null' value.", "x-one-of-name": "openapi.OpenApiSpecification.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/openapi.OpenApiSpecification" } ], "discriminator": { "propertyName": "ClassId" } }, "openapi.OpenApiSpecification": { "title": "OpenAPI Specification File Upload", "description": "An OpenAPI specification file uploaded to generate workflow tasks.", "x-allOf-name": "openapi.OpenApiSpecification", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.File" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.OpenApiSpecification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.OpenApiSpecification" ], "default": "openapi.OpenApiSpecification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.OpenApiSpecification" ], "default": "openapi.OpenApiSpecification", "x-enum-as-string": true }, "FilePath": { "description": "The path of the file in S3/minio bucket.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileUploadId": { "description": "A unique tracking ID for the file being uploaded.", "type": "string", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/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 } } } ] }, "openapi.OpenApiSpecification.List": { "title": "List of 'openapi.OpenApiSpecification' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.OpenApiSpecification' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.OpenApiSpecification' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.OpenApiSpecification" }, "nullable": true } } } ] }, "openapi.ProcessFile.Response": { "description": "The response body of a HTTP GET request for the 'openapi.ProcessFile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.ProcessFile' resources.", "x-one-of-name": "openapi.ProcessFile.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.ProcessFile.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.ProcessFile.Relationship": { "description": "A relationship to the 'openapi.ProcessFile' resource, or the expanded 'openapi.ProcessFile' resource, or the 'null' value.", "x-one-of-name": "openapi.ProcessFile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/openapi.ProcessFile" } ], "discriminator": { "propertyName": "ClassId" } }, "openapi.ProcessFile": { "title": "Openapi:Process File", "description": "Validates the OpenAPI specification file. On successful validation, it persists information about the available APIs. This information can be used to create tasks in the cloud orchestrator.", "x-allOf-name": "openapi.ProcessFile", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.ProcessFile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.ProcessFile" ], "default": "openapi.ProcessFile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.ProcessFile" ], "default": "openapi.ProcessFile", "x-enum-as-string": true }, "FailureReason": { "description": "An error message for when download, validation or processing of OpenAPI Specification fails.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileDownloadStatus": { "description": "Status of the internal OpenAPI specification fetch operation\n* `none` - Indicates the default status\n* `InProgress` - Indicates that operation is in progress\n* `Completed` - Indicates that the operation is complete\n* `Failed` - Indicates that the operation has failed. Check the failureReason attribute for more details.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "FileProcessingStatus": { "description": "Status of the OpenAPI specification processing operation. The OpenAPI specification file is processed to create APIMethod objects.\n* `none` - Indicates the default status\n* `InProgress` - Indicates that operation is in progress\n* `Completed` - Indicates that the operation is complete\n* `Failed` - Indicates that the operation has failed. Check the failureReason attribute for more details.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "FileValidationStatus": { "description": "Status of the OpenAPI specification validation operation.\n* `none` - Indicates the default status\n* `InProgress` - Indicates that operation is in progress\n* `Completed` - Indicates that the operation is complete\n* `Failed` - Indicates that the operation has failed. Check the failureReason attribute for more details.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "SpecFilePath": { "description": "The location of the previously uploaded OpenAPI specification file.", "type": "string", "x-omitempty": true }, "FileInfo": { "$ref": "#/components/schemas/openapi.OpenApiSpecification.Relationship", "description": "A reference to a openapiOpenApiSpecification resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "#/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 } } } ] }, "openapi.ProcessFile.List": { "title": "List of 'openapi.ProcessFile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.ProcessFile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.ProcessFile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.ProcessFile" }, "nullable": true } } } ] }, "openapi.TaskGenerationRequest.Response": { "description": "The response body of a HTTP GET request for the 'openapi.TaskGenerationRequest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.TaskGenerationRequest' resources.", "x-one-of-name": "openapi.TaskGenerationRequest.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.TaskGenerationRequest.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.TaskGenerationRequest.Relationship": { "description": "A relationship to the 'openapi.TaskGenerationRequest' resource, or the expanded 'openapi.TaskGenerationRequest' resource, or the 'null' value.", "x-one-of-name": "openapi.TaskGenerationRequest.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" } ], "discriminator": { "propertyName": "ClassId" } }, "openapi.TaskGenerationRequest": { "title": "Openapi:Task Generation Request", "description": "Creates a request which has information about the tasks that need to be created from the previously uploaded OpenAPI specification file. This object internally triggers a workflow that creates tasks which can be used in workflows.", "x-allOf-name": "openapi.TaskGenerationRequest", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.TaskGenerationRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.TaskGenerationRequest" ], "default": "openapi.TaskGenerationRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.TaskGenerationRequest" ], "default": "openapi.TaskGenerationRequest", "x-enum-as-string": true }, "EndpointType": { "description": "Indicates if target endpoint is external or internal. An endpoint is internal if the target is an Intersight resource. For instance, configuring an intersight object using a Task.\n* `External` - Denotes that the target endpoint is an external API endpoint.\n* `Internal` - Denotes that the target endpoint is a Intersight API endpoint.", "type": "string", "enum": [ "External", "Internal" ], "default": "External", "x-omitempty": true }, "FailedTasks": { "type": "array", "items": { "description": "List of tasks that could not be created.", "$ref": "#/components/schemas/openapi.FailedTask", "readOnly": true, "x-omitempty": true }, "nullable": true }, "HeaderParameters": { "type": "array", "items": { "description": "Common header parameters that apply to all tasks being created.", "$ref": "#/components/schemas/openapi.KeyValuePair", "x-omitempty": true }, "nullable": true }, "IsValidateRequest": { "description": "When this value is set to true, the task name validations happen and provides the task validation status against each of the selected API on the property selectedApis When this value is set to false, an internal workflow to generate the tasks is submitted, conflicting task names are created with an incremented version.", "type": "boolean", "x-omitempty": true }, "Protocol": { "description": "Specifies the REST API protocol being used, which can be one of HTTP or HTTPS.\n* `HTTPS` - Denotes that the API call uses the HTTPS protocol type\n* `HTTP` - Denotes that the API call uses the HTTP protocol type", "type": "string", "enum": [ "HTTPS", "HTTP" ], "default": "HTTPS", "x-omitempty": true }, "QueryParameters": { "type": "array", "items": { "description": "Common query parameters that apply to all GET tasks being created. These do not apply to POST, PATCH operations.", "$ref": "#/components/schemas/openapi.KeyValuePair", "x-omitempty": true }, "nullable": true }, "SelectedApis": { "type": "array", "items": { "description": "Specifies a list of APIs, Method for which tasks will be created.", "$ref": "#/components/schemas/openapi.ApiInfo", "x-omitempty": true }, "nullable": true }, "Status": { "description": "Depicts the status of the task creation request.\n* `none` - Indicates the default status.\n* `InProgress` - Request has been picked up for generating tasks from the OpenAPI Specification file.\n* `Completed` - All the tasks from the request have been created.\n* `Failed` - There were failures in generating one or more tasks in the request.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "TaskPrefix": { "description": "Optional string that can be prefixed to the name of created tasks.", "type": "string", "x-omitempty": true }, "TaskTags": { "type": "array", "items": { "description": "Tags which apply to the created tasks.", "$ref": "#/components/schemas/openapi.KeyValuePair", "x-omitempty": true }, "nullable": true }, "Url": { "description": "Specifies the URL of the endpoint that the created task communicates with. It is defaulted to intersight.com for internal endpoints.", "type": "string", "x-omitempty": true }, "Organization": { "$ref": "#/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 }, "Source": { "$ref": "#/components/schemas/openapi.ProcessFile.Relationship", "description": "A reference to a openapiProcessFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "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 } } } ] }, "openapi.TaskGenerationRequest.List": { "title": "List of 'openapi.TaskGenerationRequest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.TaskGenerationRequest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.TaskGenerationRequest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest" }, "nullable": true } } } ] }, "openapi.TaskGenerationResult.Response": { "description": "The response body of a HTTP GET request for the 'openapi.TaskGenerationResult' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'openapi.TaskGenerationResult' resources.", "x-one-of-name": "openapi.TaskGenerationResult.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/openapi.TaskGenerationResult.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "openapi.TaskGenerationResult": { "title": "Openapi:Task Generation Result", "description": "Provides information about the status of the tasks created for a TaskGenerationRequest.", "x-allOf-name": "openapi.TaskGenerationResult", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'openapi.TaskGenerationResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "openapi.TaskGenerationResult" ], "default": "openapi.TaskGenerationResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "openapi.TaskGenerationResult" ], "default": "openapi.TaskGenerationResult", "x-enum-as-string": true }, "FailureReason": { "description": "An error message for when task creation fails.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskDisplayName": { "description": "The display label of the task that is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskName": { "description": "The name of the task that is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaskStatus": { "description": "Denotes the status of the task creation.\n* `none` - Indicates the default status\n* `InProgress` - Indicates that operation is in progress\n* `Completed` - Indicates that the operation is complete\n* `Failed` - Indicates that the operation has failed. Check the failureReason attribute for more details.", "type": "string", "enum": [ "none", "InProgress", "Completed", "Failed" ], "default": "none", "readOnly": true, "x-omitempty": true }, "TaskVersion": { "description": "The version number of the created tasks.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TaskGenerationRequest": { "$ref": "#/components/schemas/openapi.TaskGenerationRequest.Relationship", "description": "A reference to a openapiTaskGenerationRequest resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "openapi.TaskGenerationResult.List": { "title": "List of 'openapi.TaskGenerationResult' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'openapi.TaskGenerationResult' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'openapi.TaskGenerationResult' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/openapi.TaskGenerationResult" }, "nullable": true } } } ] }, "oprs.Deployment.Response": { "description": "The response body of a HTTP GET request for the 'oprs.Deployment' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'oprs.Deployment' resources.", "x-one-of-name": "oprs.Deployment.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/oprs.Deployment.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "oprs.Deployment": { "title": "Oprs:Deployment", "description": "The Deployment object monitors the status of operators deployed within the assist environment. This provides insights into the operational health and configuration of deployed agents.\n#### Purpose\nDeployment is designed to ensure the continuous monitoring and management of operator deployments, providing real-time status updates and facilitating proactive maintenance.\n#### Key Concepts\n- **Status Monitoring:** Tracks the health and operational status of deployed agents.\n- **Access Control:** Utilizes privilege sets to regulate monitoring operations and ensure secure data handling.", "x-allOf-name": "oprs.Deployment", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'oprs.Deployment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oprs.Deployment" ], "default": "oprs.Deployment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oprs.Deployment" ], "default": "oprs.Deployment", "x-enum-as-string": true }, "AvailableReplicas": { "description": "Available number of replicas.", "type": "integer", "format": "int64", "x-omitempty": true }, "DesiredReplicas": { "description": "The expected number of replicas.", "type": "integer", "format": "int64", "x-omitempty": true }, "Event": { "description": "The type of event which was triggered.", "type": "string", "x-omitempty": true }, "Labels": { "type": "array", "items": { "description": "A simple key value pair type.", "$ref": "#/components/schemas/oprs.Kvpair", "x-omitempty": true }, "nullable": true }, "Name": { "description": "Agent name for which the event is triggered.", "type": "string", "x-omitempty": true }, "Namespace": { "description": "Name space in which the agents are running.", "type": "string", "x-omitempty": true }, "Status": { "description": "Status which shows if the resource is healthy or not.\n* `` - An Unknown status indicates that the resource status is not known.\n* `Healthy` - A healthy status indicates that the resource is healthy and running as per spec.\n* `Unhealthy` - An unhealthy status indicates that the resource is down.", "type": "string", "enum": [ "", "Healthy", "Unhealthy" ], "default": "", "x-omitempty": true }, "TimeStamp": { "description": "The time at which the event was generated. Date is accurate to Intersights clock. This time will be used to identify order of events.", "type": "string", "format": "date-time", "x-omitempty": true }, "UnavailableReplicas": { "description": "Number of replicas Unavailable.", "type": "integer", "format": "int64", "x-omitempty": true }, "Assist": { "$ref": "#/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." } } } ] }, "oprs.Deployment.List": { "title": "List of 'oprs.Deployment' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'oprs.Deployment' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'oprs.Deployment' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/oprs.Deployment" }, "nullable": true } } } ] }, "oprs.Kvpair": { "title": "Oprs:Kvpair", "description": "A simple key value pair type.", "x-allOf-name": "oprs.Kvpair", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'oprs.Kvpair', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oprs.Kvpair" ], "default": "oprs.Kvpair", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oprs.Kvpair" ], "default": "oprs.Kvpair", "x-enum-as-string": true }, "Key": { "description": "Name of the property which is used as key.", "type": "string", "x-omitempty": true }, "Value": { "description": "Value of the property corresponding to the key.", "type": "string", "x-omitempty": true } } } ] }, "oprs.SyncTargetListMessage.Response": { "description": "The response body of a HTTP GET request for the 'oprs.SyncTargetListMessage' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'oprs.SyncTargetListMessage' resources.", "x-one-of-name": "oprs.SyncTargetListMessage.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/oprs.SyncTargetListMessage.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "oprs.SyncTargetListMessage": { "title": "Oprs:Sync Target List Message", "description": "The SyncTargetListMessage object manages the synchronization of target lists between assist environments and Euclid for reconciliation purposes. It ensures consistent data exchange and alignment of target configurations.\n#### Purpose\nSyncTargetListMessage is designed to streamline the synchronization process, facilitating accurate and timely data updates between interconnected systems.\n#### Key Concepts\n- **Data Synchronization:** Coordinates the exchange and alignment of target lists across systems.\n- **Access Control:** Employs privilege sets to manage permissions and ensure secure data exchange.", "x-allOf-name": "oprs.SyncTargetListMessage", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'oprs.SyncTargetListMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "oprs.SyncTargetListMessage" ], "default": "oprs.SyncTargetListMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "oprs.SyncTargetListMessage" ], "default": "oprs.SyncTargetListMessage", "x-enum-as-string": true }, "AssistId": { "description": "The unique id of the assist which is associated with this message.", "type": "string", "x-omitempty": true }, "TargetType": { "description": "The target type for which this sync message is meant for.\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 }, "Targets": { "type": "array", "items": { "description": "The list of targets for which this sync message is meant for.", "type": "string", "x-omitempty": true }, "nullable": true }, "TimeStamp": { "description": "The time at which the event was generated. Date is accurate to Intersights clock. This time will be used to identify order of events.", "type": "string", "format": "date-time", "x-omitempty": true }, "Assist": { "$ref": "#/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." } } } ] }, "oprs.SyncTargetListMessage.List": { "title": "List of 'oprs.SyncTargetListMessage' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'oprs.SyncTargetListMessage' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'oprs.SyncTargetListMessage' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/oprs.SyncTargetListMessage" }, "nullable": true } } } ] }, "organization.Organization.Response": { "description": "The response body of a HTTP GET request for the 'organization.Organization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'organization.Organization' resources.", "x-one-of-name": "organization.Organization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/organization.Organization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "organization.Organization.Relationship": { "description": "A relationship to the 'organization.Organization' resource, or the expanded 'organization.Organization' resource, or the 'null' value.", "x-one-of-name": "organization.Organization.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/organization.Organization" } ], "discriminator": { "propertyName": "ClassId" } }, "organization.Organization": { "title": "Organization", "description": "Organization provides multi-tenancy within an account. Multiple organizations can be present under an account. Resources are associated to organization using resource groups. Organization can have heterogeneous resources. Resources can be shared among multiple organizations. Organizations are associated to user permissions and privileges can be specified to provide access control. User can have access to multiple organizations in same permission and with different privileges on each organization.", "x-allOf-name": "organization.Organization", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'organization.Organization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "organization.Organization" ], "default": "organization.Organization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "organization.Organization" ], "default": "organization.Organization", "x-enum-as-string": true }, "Description": { "description": "The informative description about the usage of this organization.", "type": "string", "x-omitempty": true }, "Name": { "description": "The name of the organization. There can be multiple organizations under an account.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "minLength": 1, "maxLength": 64, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "ResourceGroups": { "description": "An array of relationships to resourceGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Group.Relationship" }, "nullable": true }, "SharedWithResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "organization.Organization.List": { "title": "List of 'organization.Organization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'organization.Organization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'organization.Organization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/organization.Organization" }, "nullable": true } } } ] }, "partnerintegration.DcLogs.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.DcLogs' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.DcLogs' resources.", "x-one-of-name": "partnerintegration.DcLogs.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.DcLogs.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.DcLogs.Relationship": { "description": "A relationship to the 'partnerintegration.DcLogs' resource, or the expanded 'partnerintegration.DcLogs' resource, or the 'null' value.", "x-one-of-name": "partnerintegration.DcLogs.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/partnerintegration.DcLogs" } ], "discriminator": { "propertyName": "ClassId" } }, "partnerintegration.DcLogs": { "title": "Logs", "description": "The DcLogs object captures the standard output and error logs generated during the build operations of a device connector.\n#### Purpose\nThis provides visibility into the build process, allowing administrators to debug failures or review the progress of build and deployment tasks for device connectors.\n#### Key Concepts\n- **Log Aggregation:** Collects both standard output (`stdout`) and error logs (`stderr`) from build operations.\n- **Stage Tracking:** Associates logs with specific build stages to help pinpoint where an operation might have failed.\n- **Traceability:** Links logs directly to the parent `DeviceConnector` object for clear operational context.", "x-allOf-name": "partnerintegration.DcLogs", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.DcLogs', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.DcLogs" ], "default": "partnerintegration.DcLogs", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.DcLogs" ], "default": "partnerintegration.DcLogs", "x-enum-as-string": true }, "Stage": { "description": "Stage in the build process these logs belong to.\n* `None` - Default value for the log stage.\n* `Backend` - Logs corresponding to backend build.\n* `Ui` - Logs corresponding to ui build stage.\n* `Apidocs` - Logs corresponding to the apidocs build stage.\n* `MetricsCollectorBackend` - Logs corresponding to Metrics Collector backend build.\n* `MetricsCollectorDependentBackend` - Logs corresponding to Metrics Collector backend build.\n* `MetricsCollectorUi` - Logs corresponding to Metrics Collector ui build stage.", "type": "string", "enum": [ "None", "Backend", "Ui", "Apidocs", "MetricsCollectorBackend", "MetricsCollectorDependentBackend", "MetricsCollectorUi" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Stderr": { "type": "array", "items": { "description": "Error logs from standard error.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Stdout": { "type": "array", "items": { "description": "Log data from standard output.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DeviceConnector": { "$ref": "#/components/schemas/partnerintegration.DeviceConnector.Relationship", "description": "A reference to a partnerintegrationDeviceConnector resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "partnerintegration.DcLogs.List": { "title": "List of 'partnerintegration.DcLogs' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.DcLogs' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.DcLogs' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.DcLogs" }, "nullable": true } } } ] }, "partnerintegration.DeviceConnector.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.DeviceConnector' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.DeviceConnector' resources.", "x-one-of-name": "partnerintegration.DeviceConnector.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.DeviceConnector.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.DeviceConnector.Relationship": { "description": "A relationship to the 'partnerintegration.DeviceConnector' resource, or the expanded 'partnerintegration.DeviceConnector' resource, or the 'null' value.", "x-one-of-name": "partnerintegration.DeviceConnector.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/partnerintegration.DeviceConnector" } ], "discriminator": { "propertyName": "ClassId" } }, "partnerintegration.DeviceConnector": { "title": "Device Connector", "description": "The DeviceConnectors object acts as a recipe for building and deploying device connector services on an appliance.\n#### Purpose\nIt manages the lifecycle of device connector images, providing a mechanism to trigger builds, deployments, and file uploads to storage buckets.\n#### Key Concepts\n- **Action Orchestration:** Supports build, deploy, and upload actions to manage service images.\n- **Status Monitoring:** Tracks the build status (e.g., InProgress, Completed, Failed) to ensure successful service delivery.\n- **Image Management:** Stores metadata regarding built docker images and source file locations.", "x-allOf-name": "partnerintegration.DeviceConnector", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.DeviceConnector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.DeviceConnector" ], "default": "partnerintegration.DeviceConnector", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.DeviceConnector" ], "default": "partnerintegration.DeviceConnector", "x-enum-as-string": true }, "Action": { "description": "Action to be performed on the device connector recipe.\n* `None` - Default Value of the action, i.e. do nothing.\n* `Build` - Build the device connector service image.\n* `Deploy` - Deploy the device connector service on the appliance.\n* `Upload` - Upload a file to the Partner Integration Appliance bucket.", "type": "string", "enum": [ "None", "Build", "Deploy", "Upload" ], "default": "None", "x-omitempty": true }, "BuildStartTime": { "description": "Time when build was triggered.", "type": "string", "readOnly": true, "x-omitempty": true }, "BuildStatus": { "description": "Status of build for device connector recipe.\n* `None` - Default value of the status. i.e. done nothing.\n* `BackendInProgress` - The backend build is in progress.\n* `BackendFailed` - The backend build has failed.\n* `DockerInProgress` - The docker build is in progress.\n* `DockerFailed` - The docker build has failed.\n* `Completed` - The operation completed successfully.", "type": "string", "enum": [ "None", "BackendInProgress", "BackendFailed", "DockerInProgress", "DockerFailed", "Completed" ], "default": "None", "readOnly": true, "x-omitempty": true }, "ImageName": { "description": "Name of the docker image that is built.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the device connector recipe.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "SrcBucket": { "description": "Name of the bucket to pick up the file from.", "type": "string", "readOnly": true, "x-omitempty": true }, "SrcFileName": { "description": "Name of source file to upload.", "type": "string", "readOnly": true, "x-omitempty": true }, "Logs": { "description": "An array of relationships to partnerintegrationDcLogs resources.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.DcLogs.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "#/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 } } } ] }, "partnerintegration.DeviceConnector.List": { "title": "List of 'partnerintegration.DeviceConnector' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.DeviceConnector' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.DeviceConnector' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.DeviceConnector" }, "nullable": true } } } ] }, "partnerintegration.DocIssues.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.DocIssues' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.DocIssues' resources.", "x-one-of-name": "partnerintegration.DocIssues.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.DocIssues.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.DocIssues.Relationship": { "description": "A relationship to the 'partnerintegration.DocIssues' resource, or the expanded 'partnerintegration.DocIssues' resource, or the 'null' value.", "x-one-of-name": "partnerintegration.DocIssues.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/partnerintegration.DocIssues" } ], "discriminator": { "propertyName": "ClassId" } }, "partnerintegration.DocIssues": { "title": "Doc Issues", "description": "The DocIssues object captures documentation-related issues identified during the build operation of an inventory collection.\n#### Purpose\nThis provides feedback on documentation generation, allowing developers to identify and resolve issues in the generated API documentation or SDKs.\n#### Key Concepts\n- **Issue Tracking:** Lists specific documentation errors or warnings encountered during the build.\n- **Quality Assurance:** Helps ensure that generated documentation is accurate and complete.", "x-allOf-name": "partnerintegration.DocIssues", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.DocIssues', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.DocIssues" ], "default": "partnerintegration.DocIssues", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.DocIssues" ], "default": "partnerintegration.DocIssues", "x-enum-as-string": true }, "DocumentationIssues": { "description": "List of documentation issues.", "nullable": true, "readOnly": true, "x-omitempty": true }, "Inventory": { "$ref": "#/components/schemas/partnerintegration.Inventory.Relationship", "description": "A reference to a partnerintegrationInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "partnerintegration.DocIssues.List": { "title": "List of 'partnerintegration.DocIssues' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.DocIssues' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.DocIssues' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.DocIssues" }, "nullable": true } } } ] }, "partnerintegration.Etl.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.Etl' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.Etl' resources.", "x-one-of-name": "partnerintegration.Etl.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.Etl.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.Etl.Relationship": { "description": "A relationship to the 'partnerintegration.Etl' resource, or the expanded 'partnerintegration.Etl' resource, or the 'null' value.", "x-one-of-name": "partnerintegration.Etl.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/partnerintegration.Etl" } ], "discriminator": { "propertyName": "ClassId" } }, "partnerintegration.Etl": { "title": "Transform", "description": "The Etls object defines the transformation logic used to translate platform-specific API outputs into Intersight-managed objects.\n#### Purpose\nIt serves as the transformation engine for inventory data, enabling the system to ingest data from various platforms and normalize it into a common model.\n#### Key Concepts\n- **Data Transformation:** Uses YAML-based models to map raw API data to managed objects.\n- **Normalization:** Ensures consistent data structure across different integrated platforms.\n- **Inventory Integration:** Links transformation definitions to specific inventory collections.", "x-allOf-name": "partnerintegration.Etl", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.Etl', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.Etl" ], "default": "partnerintegration.Etl", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.Etl" ], "default": "partnerintegration.Etl", "x-enum-as-string": true }, "Data": { "description": "Transformation model in yaml format.", "nullable": true, "x-omitempty": true }, "Name": { "description": "Placeholder name for the ETL.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Inventory": { "$ref": "#/components/schemas/partnerintegration.Inventory.Relationship", "description": "A reference to a partnerintegrationInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "partnerintegration.Etl.List": { "title": "List of 'partnerintegration.Etl' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.Etl' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.Etl' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.Etl" }, "nullable": true } } } ] }, "partnerintegration.File.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.File' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.File' resources.", "x-one-of-name": "partnerintegration.File.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.File.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.File": { "title": "Partner Integration File Artifact", "description": "The PartnerIntegrationFile object is a partner integration artifact, containing development code uploaded by partners for building DC/microservices. It supports collaborative development and integration processes.\n#### Purpose\nPartnerIntegrationFile serves as a repository for partner development artifacts, facilitating integration and collaboration within the development ecosystem.\n#### Key Concepts\n- **Collaboration:** Supports partner development efforts by providing a structured artifact repository.\n- **Integration:** Facilitates integration processes by housing development code for DC/microservice builds.\n- **Management Tools:** Offers administrative capabilities for managing partner uploads and integrations.\n- **Security:** Ensures that partner artifacts are securely managed and accessed within the system.", "x-allOf-name": "partnerintegration.File", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.File" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.File', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.File" ], "default": "partnerintegration.File", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.File" ], "default": "partnerintegration.File", "x-enum-as-string": true }, "FilePath": { "description": "Path of the file being uploaded.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileType": { "description": "Type of the file being uploaded.\n* `None` - Invalid file type for partnerIntegration appliance.\n* `Model` - Model file of Generic Device.\n* `Etl` - ETL file of Generic Device.\n* `Ui` - UI file of Generic Device.\n* `DeviceConnector` - Generic Device Connector file.", "type": "string", "enum": [ "None", "Model", "Etl", "Ui", "DeviceConnector" ], "default": "None", "x-omitempty": true }, "WorkspaceName": { "description": "The partner integration workspace to use to upload the File.", "type": "string", "default": "default", "readOnly": true, "x-omitempty": true }, "Catalog": { "$ref": "#/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 } } } ] }, "partnerintegration.File.List": { "title": "List of 'partnerintegration.File' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.File' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.File' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.File" }, "nullable": true } } } ] }, "partnerintegration.Inventory.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.Inventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.Inventory' resources.", "x-one-of-name": "partnerintegration.Inventory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.Inventory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.Inventory.Relationship": { "description": "A relationship to the 'partnerintegration.Inventory' resource, or the expanded 'partnerintegration.Inventory' resource, or the 'null' value.", "x-one-of-name": "partnerintegration.Inventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/partnerintegration.Inventory" } ], "discriminator": { "propertyName": "ClassId" } }, "partnerintegration.Inventory": { "title": "Inventory Collection", "description": "Inventory Collection object that acts as an aggregator object for the underlying model and ETL objects.", "x-allOf-name": "partnerintegration.Inventory", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.Inventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.Inventory" ], "default": "partnerintegration.Inventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.Inventory" ], "default": "partnerintegration.Inventory", "x-enum-as-string": true }, "Action": { "description": "Action to be performed on the inventory collection.\n* `None` - Default Value of the action, i.e. do nothing.\n* `Build` - Build the inventory service image.\n* `Deploy` - Deploy the inventory service on the appliance.", "type": "string", "enum": [ "None", "Build", "Deploy" ], "default": "None", "x-omitempty": true }, "BuildFlags": { "description": "Addtional flags to control build action.", "type": "string", "x-omitempty": true }, "BuildStartTime": { "description": "Time when build was triggered.", "type": "string", "readOnly": true, "x-omitempty": true }, "BuildStatus": { "description": "Status of build for inventory collection.\n* `None` - Default value of the status. i.e. done nothing.\n* `BackendInProgress` - The backend build is in progress.\n* `BackendFailed` - The backend build has failed.\n* `MetricsCollectorBackendInProgress` - The Metrics Collector backend build is in progress.\n* `MetricsCollectorBackendFailed` - The Metrics Collector backend build has failed.\n* `DockerInProgress` - The docker build is in progress.\n* `DockerFailed` - The docker build has failed.\n* `UiInProgress` - The UI build is in progress.\n* `UiFailed` - The inventory UI build has failed.\n* `MetricsCollectorUiInProgress` - The Metrics Collector UI build is in progress.\n* `MetricsCollectorUiFailed` - The Metrics Collector UI build has failed.\n* `MetricsCollectorDependentBackendInProgress` - The Metrics Collector dependent backend build is in progress.\n* `MetricsCollectorDependentBackendFailed` - The Metrics Collector dependent backend build has failed.\n* `MetricsCollectorDependentDockerInProgress` - The Metrics Collector dependent docker build is in progress.\n* `MetricsCollectorDependentDockerFailed` - The Metrics Collector dependent docker build has failed.\n* `ApidocsInProgress` - The apidocs build is in progress.\n* `ApidocsFailed` - The apidocs build has failed.\n* `Completed` - The operation completed successfully.", "type": "string", "enum": [ "None", "BackendInProgress", "BackendFailed", "MetricsCollectorBackendInProgress", "MetricsCollectorBackendFailed", "DockerInProgress", "DockerFailed", "UiInProgress", "UiFailed", "MetricsCollectorUiInProgress", "MetricsCollectorUiFailed", "MetricsCollectorDependentBackendInProgress", "MetricsCollectorDependentBackendFailed", "MetricsCollectorDependentDockerInProgress", "MetricsCollectorDependentDockerFailed", "ApidocsInProgress", "ApidocsFailed", "Completed" ], "default": "None", "readOnly": true, "x-omitempty": true }, "DeployStartTime": { "description": "Time when deploy was triggered.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeployStatus": { "description": "Status of deployment of the inventory microservice.\n* `None` - Default value of the status. i.e. done nothing.\n* `Completed` - The operation completed successfully.\n* `Failed` - The deploy operation failed.", "type": "string", "enum": [ "None", "Completed", "Failed" ], "default": "None", "readOnly": true, "x-omitempty": true }, "ImageName": { "description": "Name of the docker image that is built.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the inventory collection.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "PythonSdkUrl": { "description": "Link to the generated v3 python SDK.", "type": "string", "readOnly": true, "x-omitempty": true }, "DocIssues": { "description": "An array of relationships to partnerintegrationDocIssues resources.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.DocIssues.Relationship" }, "nullable": true, "readOnly": true }, "Etls": { "description": "An array of relationships to partnerintegrationEtl resources.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.Etl.Relationship" }, "nullable": true }, "Logs": { "description": "An array of relationships to partnerintegrationLogs resources.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.Logs.Relationship" }, "nullable": true, "readOnly": true }, "Metrics": { "$ref": "#/components/schemas/partnerintegration.Metrics.Relationship", "description": "A reference to a partnerintegrationMetrics resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Models": { "description": "An array of relationships to partnerintegrationModel resources.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.Model.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/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 } } } ] }, "partnerintegration.Inventory.List": { "title": "List of 'partnerintegration.Inventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.Inventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.Inventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.Inventory" }, "nullable": true } } } ] }, "partnerintegration.Logs.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.Logs' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.Logs' resources.", "x-one-of-name": "partnerintegration.Logs.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.Logs.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.Logs.Relationship": { "description": "A relationship to the 'partnerintegration.Logs' resource, or the expanded 'partnerintegration.Logs' resource, or the 'null' value.", "x-one-of-name": "partnerintegration.Logs.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/partnerintegration.Logs" } ], "discriminator": { "propertyName": "ClassId" } }, "partnerintegration.Logs": { "title": "Logs", "description": "The Logs object captures the standard output and error logs generated during the build operation of an inventory collection.\n#### Purpose\nSimilar to `DcLogs`, this object provides detailed logs for inventory build processes, enabling troubleshooting of build failures or performance issues.\n#### Key Concepts\n- **Build Visibility:** Tracks `stdout` and `stderr` for inventory build operations.\n- **Stage-Based Logging:** Categorizes logs by build stage (e.g., Backend, UI, Apidocs) to simplify debugging.", "x-allOf-name": "partnerintegration.Logs", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.Logs', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.Logs" ], "default": "partnerintegration.Logs", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.Logs" ], "default": "partnerintegration.Logs", "x-enum-as-string": true }, "Stage": { "description": "Stage in the build process these logs belong to.\n* `None` - Default value for the log stage.\n* `Backend` - Logs corresponding to backend build.\n* `Ui` - Logs corresponding to ui build stage.\n* `Apidocs` - Logs corresponding to the apidocs build stage.\n* `MetricsCollectorBackend` - Logs corresponding to Metrics Collector backend build.\n* `MetricsCollectorDependentBackend` - Logs corresponding to Metrics Collector backend build.\n* `MetricsCollectorUi` - Logs corresponding to Metrics Collector ui build stage.", "type": "string", "enum": [ "None", "Backend", "Ui", "Apidocs", "MetricsCollectorBackend", "MetricsCollectorDependentBackend", "MetricsCollectorUi" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Stderr": { "type": "array", "items": { "description": "Error logs from the standard error.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Stdout": { "type": "array", "items": { "description": "Log data from standard output.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Inventory": { "$ref": "#/components/schemas/partnerintegration.Inventory.Relationship", "description": "A reference to a partnerintegrationInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "partnerintegration.Logs.List": { "title": "List of 'partnerintegration.Logs' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.Logs' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.Logs' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.Logs" }, "nullable": true } } } ] }, "partnerintegration.Metrics.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.Metrics' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.Metrics' resources.", "x-one-of-name": "partnerintegration.Metrics.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.Metrics.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.Metrics.Relationship": { "description": "A relationship to the 'partnerintegration.Metrics' resource, or the expanded 'partnerintegration.Metrics' resource, or the 'null' value.", "x-one-of-name": "partnerintegration.Metrics.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/partnerintegration.Metrics" } ], "discriminator": { "propertyName": "ClassId" } }, "partnerintegration.Metrics": { "title": "Metrics", "description": "The Metrics object defines how platform API outputs are translated into the Intersight Metrics format.\n#### Purpose\nIt allows for the transformation of raw platform metrics into a standardized format, enabling consistent monitoring and analysis across different storage or networking platforms.\n#### Key Concepts\n- **Metric Transformation:** Maps platform-specific metrics to the Intersight Metrics model.\n- **Standardization:** Ensures that metrics are represented consistently, regardless of the source platform.", "x-allOf-name": "partnerintegration.Metrics", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.Metrics', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.Metrics" ], "default": "partnerintegration.Metrics", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.Metrics" ], "default": "partnerintegration.Metrics", "x-enum-as-string": true }, "Data": { "description": "Transformation model in metrics format.", "$ref": "#/components/schemas/partnerintegration.MetricsModel", "x-omitempty": true }, "Name": { "description": "Placeholder name for the Metrics.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Inventory": { "$ref": "#/components/schemas/partnerintegration.Inventory.Relationship", "description": "A reference to a partnerintegrationInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "partnerintegration.Metrics.List": { "title": "List of 'partnerintegration.Metrics' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.Metrics' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.Metrics' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.Metrics" }, "nullable": true } } } ] }, "partnerintegration.MetricsModel": { "title": "Partnerintegration:Metrics Model", "description": "Transformation model in metrics format.", "x-allOf-name": "partnerintegration.MetricsModel", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.MetricsModel', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.MetricsModel" ], "default": "partnerintegration.MetricsModel", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.MetricsModel" ], "default": "partnerintegration.MetricsModel", "x-enum-as-string": true }, "Attributes": { "description": "Transformation attributes model in yaml format.", "nullable": true, "x-omitempty": true }, "DruidInstrumentExporters": { "description": "Transformation druid instrument exporters model in yaml format.", "nullable": true, "x-omitempty": true }, "Instruments": { "description": "Transformation instruments model in yaml format.", "nullable": true, "x-omitempty": true }, "MeterProviders": { "description": "Transformation meter providers model in yaml format.", "nullable": true, "x-omitempty": true }, "Metrics": { "description": "Transformation metrics model in yaml format.", "nullable": true, "x-omitempty": true } } } ] }, "partnerintegration.Model.Response": { "description": "The response body of a HTTP GET request for the 'partnerintegration.Model' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'partnerintegration.Model' resources.", "x-one-of-name": "partnerintegration.Model.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/partnerintegration.Model.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "partnerintegration.Model.Relationship": { "description": "A relationship to the 'partnerintegration.Model' resource, or the expanded 'partnerintegration.Model' resource, or the 'null' value.", "x-one-of-name": "partnerintegration.Model.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/partnerintegration.Model" } ], "discriminator": { "propertyName": "ClassId" } }, "partnerintegration.Model": { "title": "Model", "description": "The Model object defines the endpoint model used for inventory collections.\n#### Purpose\nThis provides the schema definition for the inventory endpoints, ensuring that the data structure is clearly defined and consistent for API consumption.\n#### Key Concepts\n- **Schema Definition:** Stores the endpoint model in YAML/JSON format.\n- **Endpoint Integration:** Defines the structure of the data exposed by the inventory service.", "x-allOf-name": "partnerintegration.Model", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'partnerintegration.Model', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "partnerintegration.Model" ], "default": "partnerintegration.Model", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "partnerintegration.Model" ], "default": "partnerintegration.Model", "x-enum-as-string": true }, "Data": { "description": "Endpoint model in yaml format.", "nullable": true, "x-omitempty": true }, "Name": { "description": "Placeholder name for the model.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Inventory": { "$ref": "#/components/schemas/partnerintegration.Inventory.Relationship", "description": "A reference to a partnerintegrationInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "partnerintegration.Model.List": { "title": "List of 'partnerintegration.Model' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'partnerintegration.Model' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'partnerintegration.Model' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/partnerintegration.Model" }, "nullable": true } } } ] }, "pkix.DistinguishedName": { "title": "Pkix:Distinguished Name", "description": "The identifier for the owner of an X.509 certificate and the authority that issued the certificate.", "x-allOf-name": "pkix.DistinguishedName", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'pkix.DistinguishedName', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pkix.DistinguishedName" ], "default": "pkix.DistinguishedName", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pkix.DistinguishedName" ], "default": "pkix.DistinguishedName", "x-enum-as-string": true }, "CommonName": { "description": "A required component that identifies a person or an object.", "type": "string", "readOnly": true, "x-omitempty": true }, "Country": { "type": "array", "items": { "description": "Identifier for the country in which the entity resides.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Locality": { "type": "array", "items": { "description": "Identifier for the place where the entry resides. The locality can be a city, county, township, or other geographic region.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Organization": { "type": "array", "items": { "description": "Identifier for the organization in which the entity resides.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OrganizationalUnit": { "type": "array", "items": { "description": "Identifier for a unit within the organization.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "State": { "type": "array", "items": { "description": "Identifier for the state or province of the entity.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "pkix.EcdsaKeySpec": { "title": "Pkix:Ecdsa Key Spec", "description": "The key pair is generated using Elliptic Curve Digital Signature Algorithm (ECDSA), as defined in FIPS 186-4.\nThe ECDSA standard was originally developed for the American National Standards Institute by the Accredited\nStandards Committee on Financial Services, X9.\nANS X9.62 defines methods for digital signature generation and verification using ECDSA. Specifications for\nthe generation of the domain parameters used during the generation and verification of digital signatures\nare also included in ANS X9.62.", "x-allOf-name": "pkix.EcdsaKeySpec", "allOf": [ { "$ref": "#/components/schemas/pkix.KeyGenerationSpec" }, { "type": "object", "description": "Definition of the list of properties defined in 'pkix.EcdsaKeySpec', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pkix.EcdsaKeySpec" ], "default": "pkix.EcdsaKeySpec", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pkix.EcdsaKeySpec" ], "default": "pkix.EcdsaKeySpec", "x-enum-as-string": true }, "Curve": { "description": "A specific set of Elliptic Curve parameters, as recommended by NIST in FIPS 186-4.\n* `P256` - P256 returns a Curve which implements P-256, as defined in FIPS 186-4, section D.2.3.\n* `P224` - P224 returns a Curve which implements P-224, as defined in FIPS 186-4, section D.2.2.\n* `P384` - P384 returns a Curve which implements P-384, as defined in FIPS 186-4, section D.2.4.\n* `P521` - P521 returns a Curve which implements P-521, as defined in FIPS 186-4, section D.2.5.", "type": "string", "enum": [ "P256", "P224", "P384", "P521" ], "default": "P256", "x-omitempty": true } } } ] }, "pkix.EddsaKeySpec": { "title": "Pkix:Eddsa Key Spec", "description": "The key pair is generated using Edwards-Curve Digital Signature Algorithm (EdDSA).\nThe Edwards-curve Digital Signature Algorithm (EdDSA) is a variant of\nSchnorr's signature system with (possibly twisted) Edwards curves.", "x-allOf-name": "pkix.EddsaKeySpec", "allOf": [ { "$ref": "#/components/schemas/pkix.KeyGenerationSpec" }, { "type": "object", "description": "Definition of the list of properties defined in 'pkix.EddsaKeySpec', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pkix.EddsaKeySpec" ], "default": "pkix.EddsaKeySpec", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pkix.EddsaKeySpec" ], "default": "pkix.EddsaKeySpec", "x-enum-as-string": true }, "Algorithm": { "description": "The EdDSA algorithm, as defined in RFC 8032.\n* `Ed25519` - The edwards25519 curve, as defined in RFC 8032 section 5.1.\n* `Ed25519ph` - The edwards25519 curve for the PureEdDSA variant.\n* `Ed25519ctx` - The edwards25519 curve for the HashEdDSA variant.", "type": "string", "enum": [ "Ed25519", "Ed25519ph", "Ed25519ctx" ], "default": "Ed25519", "x-omitempty": true } } } ] }, "pkix.KeyGenerationSpec": { "title": "Pkix:Key Generation Spec", "description": "The key generation spec provides the algorithm and the parameters required for this algorithm to generate a key.", "x-allOf-name": "pkix.KeyGenerationSpec", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'pkix.KeyGenerationSpec', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "pkix.EcdsaKeySpec", "pkix.EddsaKeySpec", "pkix.RsaAlgorithm" ], "x-enum-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": [ "pkix.EcdsaKeySpec", "pkix.EddsaKeySpec", "pkix.RsaAlgorithm" ], "x-enum-as-string": true }, "Name": { "description": "Name of the key generation algorithm.\n* `RSA` - Key pairs should be generated by the RSA algorithm.", "type": "string", "enum": [ "RSA" ], "default": "RSA", "readOnly": true, "x-omitempty": true } } } ] }, "pkix.RsaAlgorithm": { "title": "Pkix:Rsa Algorithm", "description": "The key pair is generated using the RSA algorithm and specified parameters.", "x-allOf-name": "pkix.RsaAlgorithm", "allOf": [ { "$ref": "#/components/schemas/pkix.KeyGenerationSpec" }, { "type": "object", "description": "Definition of the list of properties defined in 'pkix.RsaAlgorithm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pkix.RsaAlgorithm" ], "default": "pkix.RsaAlgorithm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pkix.RsaAlgorithm" ], "default": "pkix.RsaAlgorithm", "x-enum-as-string": true }, "Modulus": { "description": "The length of the RSA key, expressed in bits, for both public and private keys.\n* `2048` - A key length of 2048 bits.\n* `2560` - A key length of 2560 bits.\n* `3072` - A key length of 3072 bits.\n* `3584` - A key length of 3584 bits.\n* `4096` - A key length of 4096 bits.", "type": "integer", "enum": [ 2048, 2560, 3072, 3584, 4096 ], "default": 2048, "x-omitempty": true } } } ] }, "pkix.SubjectAlternateName": { "title": "Pkix:Subject Alternate Name", "description": "The additional hostnames to be protected by a given X.509 certificate.", "x-allOf-name": "pkix.SubjectAlternateName", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'pkix.SubjectAlternateName', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pkix.SubjectAlternateName" ], "default": "pkix.SubjectAlternateName", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pkix.SubjectAlternateName" ], "default": "pkix.SubjectAlternateName", "x-enum-as-string": true }, "DnsName": { "type": "array", "items": { "description": "Alternate DNS names for the host.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "EmailAddress": { "type": "array", "items": { "description": "Alternate email addresses for the host.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IpAddress": { "type": "array", "items": { "description": "Alternate IP addresses for the host.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Uri": { "type": "array", "items": { "description": "Alternate URIs for the host.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "policy.AbstractConfigChangeDetail": { "title": "Policy:Abstract Config Change Detail", "description": "Defines the details of a configuration change including change type, disruption and description of the change.", "x-allOf-name": "policy.AbstractConfigChangeDetail", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractConfigChangeDetail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.ConfigChangeDetail", "fabric.ConfigChangeDetail", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "chassis.ConfigChangeDetail", "fabric.ConfigChangeDetail", "server.ConfigChangeDetail" ], "x-enum-as-string": true }, "Changes": { "type": "array", "items": { "description": "Type of the configuration change.", "type": "string", "x-omitempty": true }, "nullable": true }, "ConfigChangeContext": { "description": "Context information on the change.", "$ref": "#/components/schemas/policy.ConfigResultContext", "x-omitempty": true }, "ConfigChangeFlag": { "description": "Config change flag to differentiate Pending-changes and Config-drift.\n* `Pending-changes` - Config change flag represents changes are due to not deployed changes from Intersight.\n* `Drift-changes` - Config change flag represents changes are due to endpoint configuration changes.", "type": "string", "enum": [ "Pending-changes", "Drift-changes" ], "default": "Pending-changes", "x-omitempty": true }, "Disruptions": { "type": "array", "items": { "description": "Possible disruptions the configuration change might cause.", "type": "string", "x-omitempty": true }, "nullable": true }, "Message": { "description": "Detailed description of the config change.", "type": "string", "x-omitempty": true }, "ModStatus": { "description": "Modification status of the mo in this config change.\n* `None` - The 'none' operation/state.Indicates a configuration profile has been deployed, and the desired configuration matches the actual device configuration.\n* `Created` - The 'create' operation/state.Indicates a configuration profile has been created and associated with a device, but the configuration specified in the profilehas not been applied yet. For example, this could happen when the user creates a server profile and has not deployed the profile yet.\n* `Modified` - The 'update' operation/state.Indicates some of the desired configuration changes specified in a profile have not been been applied to the associated device.This happens when the user has made changes to a profile and has not deployed the changes yet, or when the workflow to applythe configuration changes has not completed successfully.\n* `Deleted` - The 'delete' operation/state.Indicates a configuration profile has been been disassociated from a device and the user has not undeployed these changes yet.", "type": "string", "enum": [ "None", "Created", "Modified", "Deleted" ], "default": "None", "x-omitempty": true } } } ] }, "policy.AbstractConfigProfile.Relationship": { "description": "A relationship to the 'policy.AbstractConfigProfile' resource, or the expanded 'policy.AbstractConfigProfile' resource, or the 'null' value.", "x-one-of-name": "policy.AbstractConfigProfile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/policy.AbstractConfigProfile" } ], "discriminator": { "propertyName": "ClassId" } }, "policy.AbstractConfigProfile": { "title": "Policy:Abstract Config Profile", "description": "AbstractConfigProfile is an abstract base type for all config actions on a profile.", "x-allOf-name": "policy.AbstractConfigProfile", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractConfigProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.IomProfile", "chassis.Profile", "chassis.ProfileTemplate", "fabric.SwitchProfile", "fabric.SwitchProfileTemplate", "hyperflex.ClusterProfile", "hyperflex.NodeProfile", "recovery.BackupProfile", "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": [ "chassis.IomProfile", "chassis.Profile", "chassis.ProfileTemplate", "fabric.SwitchProfile", "fabric.SwitchProfileTemplate", "hyperflex.ClusterProfile", "hyperflex.NodeProfile", "recovery.BackupProfile", "server.Profile", "server.ProfileTemplate" ], "x-enum-as-string": true }, "Action": { "description": "User initiated action. Each profile type has its own supported actions. For HyperFlex cluster profile, the supported actions are -- Validate, Deploy, Continue, Retry, Abort, Unassign For server profile, the support actions are -- Deploy, Unassign.", "type": "string", "default": "No-op", "x-omitempty": true }, "ActionParams": { "type": "array", "items": { "description": "Action parameters for the user initiated action. For day-2 operations on HyperFlex Cluster Profile, actions like encrypt, rekey, expand, upgrade etc will have action parameters which are collection of key:value pairs. e.g. dryrun:true, validate:true, etc.", "$ref": "#/components/schemas/policy.ActionParam", "x-omitempty": true }, "nullable": true }, "ConfigContext": { "description": "The configuration state and results of the last configuration operation.", "$ref": "#/components/schemas/policy.ConfigContext", "x-omitempty": true }, "DeployedPolicies": { "type": "array", "items": { "description": "List of policy types which are deployed on the endpoint from Intersight. We do not have a way to track if a policy was deployed or not from the profile service. Only policy service stores that information along with the deployed configuration. For cases where a policy needs to be added to the removed list when it is detached from the profile, to ensure that only those policies which were deployed, we will have to make one remote call to per policy removed. Inorder to avoid these remote calls in the user request flow, it is good to maintain the list of policy types deployed in the profile service itself.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PartiallyDeployedPolicies": { "type": "array", "items": { "description": "List of policy types which are partially deployed on the endpoint from Intersight.", "$ref": "#/components/schemas/policy.PolicyContextHolder", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PolicyChangeDetails": { "type": "array", "items": { "description": "A transient property that is used by policy services to report change details for the profile corresponding to a single policy.", "$ref": "#/components/schemas/policy.ConfigChangeDetailType", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RemovedPolicies": { "type": "array", "items": { "description": "List of policy types which are removed from last deploy or removed and pending activation.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ReportedPolicyChanges": { "type": "array", "items": { "description": "Tracks policy changes that have been reported for the profile.", "$ref": "#/components/schemas/policy.ReportedPolicyChange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ScheduledActions": { "type": "array", "items": { "description": "User-initiated actions that will be executed in an asynchronous way. User can schedule actions, deploy, activate, or both. Example, user can schedule deploy before pending changes are evaluated, or schedule activate after deploy if reboot will happen as part of deploy.", "$ref": "#/components/schemas/policy.ScheduledAction", "x-omitempty": true }, "nullable": true }, "IncompletePolicies": { "description": "An array of relationships to policyAbstractPolicy resources.", "type": "array", "items": { "$ref": "#/components/schemas/policy.AbstractPolicy.Relationship" }, "nullable": true, "readOnly": true }, "PolicyBucket": { "description": "An array of relationships to policyAbstractPolicy resources.", "type": "array", "items": { "$ref": "#/components/schemas/policy.AbstractPolicy.Relationship" }, "nullable": true } } } ] }, "policy.AbstractConfigResult": { "title": "Policy:Abstract Config Result", "description": "The results with the overall state and detailed result messages.", "x-allOf-name": "policy.AbstractConfigResult", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractConfigResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.ConfigResult", "fabric.ConfigResult", "hyperflex.ConfigResult", "recovery.ConfigResult", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "chassis.ConfigResult", "fabric.ConfigResult", "hyperflex.ConfigResult", "recovery.ConfigResult", "server.ConfigResult" ], "x-enum-as-string": true }, "AppliedPolicies": { "type": "array", "items": { "description": "The attach progress/success/failure status of all the policies attached to the Profile/Template.\n(1) The attach/detach of any policy to the profile/template is an asynchronous operation. The result \nof the operation is received from the respective policy service and logged as per policy status. \nOn success, the PolicyStatus may be as follows - \n{\n \"ObjectType\": \"policy.PolicyStatus\",\n \"Reason\": \"\",\n \"Status\": \"ok\", \n \"Type\": \"vnic.SanConnectivityPolicy\"\n}\nOn failure, the PolicyStatus may be as follows -\n{\n \"ObjectType\": \"policy.PolicyStatus\",\n \"Reason\": \"LAN Connectivity Policy 'imm-lcp-static-pol-1' could not be attached to profile, 'Cannot attach a policy to the server template as static address is used in vNIC 'vn-man1''\"\",\n \"Status\": \"error\", \n \"Type\": \"vnic.LanConnectivityPolicy\"\n}\n(2) When attach/detach is in progress, the 'Status' field is set to 'validating'.", "$ref": "#/components/schemas/policy.PolicyStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ConfigStage": { "description": "The current running stage of the configuration or workflow.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigState": { "description": "Indicates overall configuration state for applying the configuration to the end point. Values -- Ok, Ok-with-warning, Errored.", "type": "string", "readOnly": true, "x-omitempty": true }, "ValidationState": { "description": "Indicates overall state for logical model validation. Values -- Ok, Ok-with-warning, Errored.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "policy.AbstractConfigResultEntry": { "title": "Policy:Abstract Config Result Entry", "description": "The results details information.", "x-allOf-name": "policy.AbstractConfigResultEntry", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractConfigResultEntry', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.ConfigResultEntry", "fabric.ConfigResultEntry", "hyperflex.ConfigResultEntry", "recovery.ConfigResultEntry", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "chassis.ConfigResultEntry", "fabric.ConfigResultEntry", "hyperflex.ConfigResultEntry", "recovery.ConfigResultEntry", "server.ConfigResultEntry" ], "x-enum-as-string": true }, "CompletedTime": { "description": "The completed time of the task in installer.", "type": "string", "x-omitempty": true }, "Context": { "description": "Context information on the change.", "$ref": "#/components/schemas/policy.ConfigResultContext", "x-omitempty": true }, "Message": { "description": "Localized message based on the locale setting of the user's context.", "type": "string", "x-omitempty": true }, "OwnerId": { "description": "The identifier of the object that owns the result message.\nThe owner ID is used to correlate a given result entry to a task or entity. For example, a config result\nentry that describes the result of a workflow task may have the task's instance ID as the owner.", "type": "string", "x-omitempty": true }, "State": { "description": "Values -- Ok, Ok-with-warning, Errored.", "type": "string", "x-omitempty": true }, "Type": { "description": "Indicates if the result is reported during the logical model validation/resource allocation phase. or the configuration applying phase. Values -- validation, config.", "type": "string", "x-omitempty": true } } } ] }, "policy.AbstractConfigurationObject": { "title": "Policy:Abstract Configuration Object", "description": "Abstract base type for all configuration objects. All logical objects like profiles, policies, policy items like vnic, vhba and templates extend from this type. It helps with querying all logical objects belonging to an organization.", "x-allOf-name": "policy.AbstractConfigurationObject", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" } ] }, "policy.AbstractDisruption": { "title": "Policy:Abstract Disruption", "description": "Base class of all disruption types.", "x-allOf-name": "policy.AbstractDisruption", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractDisruption', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "server.Disruption" ], "default": "server.Disruption", "x-enum-as-string": true }, "Label": { "description": "Description of the disruption.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Disruption that happens when the policy is deployed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "Severity of the disruption.\n* `Minor` - A disruption of minor severity.\n* `Major` - A disruption of major severity.\n* `Moderate` - A disruption of moderate severity.", "type": "string", "enum": [ "Minor", "Major", "Moderate" ], "default": "Minor", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of disruption that happens when the policy is deployed.\n* `Informational` - Disruptions categorized as informational do not require any user action, nor do they cause a reboot.\n* `ActionRequired` - User action is required to deploy the profile.", "type": "string", "enum": [ "Informational", "ActionRequired" ], "default": "Informational", "readOnly": true, "x-omitempty": true } } } ] }, "policy.AbstractInventory": { "title": "PolicyInventory", "description": "A base abstract class used to represent all inventoried objects from a profile associated resource.", "x-allOf-name": "policy.AbstractInventory", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "access.PolicyInventory", "certificatemanagement.PolicyInventory", "compute.PcieConnectivityPolicyInventory", "fabric.EthNetworkControlPolicyInventory", "fabric.EthNetworkGroupPolicyInventory", "firmware.FirmwareSummary", "iam.EndPointUserInventory", "iam.EndPointUserPolicyInventory", "iam.EndPointUserRoleInventory", "iam.LdapGroupInventory", "iam.LdapPolicyInventory", "iam.LdapProviderInventory", "ipmioverlan.PolicyInventory", "kvm.PolicyInventory", "memory.PolicyInventory", "networkconfig.PolicyInventory", "ntp.PolicyInventory", "power.PolicyInventory", "sdcard.PolicyInventory", "smtp.PolicyInventory", "snmp.PolicyInventory", "sol.PolicyInventory", "ssh.PolicyInventory", "syslog.PolicyInventory", "thermal.PolicyInventory", "vmedia.PolicyInventory", "vnic.EthAdapterPolicyInventory", "vnic.EthIfInventory", "vnic.EthNetworkPolicyInventory", "vnic.EthQosPolicyInventory", "vnic.EthVethInventory", "vnic.EthVnicInventory", "vnic.FcAdapterPolicyInventory", "vnic.FcIfInventory", "vnic.FcNetworkPolicyInventory", "vnic.FcQosPolicyInventory", "vnic.FcVethInventory", "vnic.FcVhbaPolicyInventory", "vnic.IscsiAdapterPolicyInventory", "vnic.IscsiBootPolicyInventory", "vnic.IscsiStaticTargetPolicyInventory", "vnic.LanConnectivityPolicyInventory", "vnic.SanConnectivityPolicyInventory", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "access.PolicyInventory", "certificatemanagement.PolicyInventory", "compute.PcieConnectivityPolicyInventory", "fabric.EthNetworkControlPolicyInventory", "fabric.EthNetworkGroupPolicyInventory", "firmware.FirmwareSummary", "iam.EndPointUserInventory", "iam.EndPointUserPolicyInventory", "iam.EndPointUserRoleInventory", "iam.LdapGroupInventory", "iam.LdapPolicyInventory", "iam.LdapProviderInventory", "ipmioverlan.PolicyInventory", "kvm.PolicyInventory", "memory.PolicyInventory", "networkconfig.PolicyInventory", "ntp.PolicyInventory", "power.PolicyInventory", "sdcard.PolicyInventory", "smtp.PolicyInventory", "snmp.PolicyInventory", "sol.PolicyInventory", "ssh.PolicyInventory", "syslog.PolicyInventory", "thermal.PolicyInventory", "vmedia.PolicyInventory", "vnic.EthAdapterPolicyInventory", "vnic.EthIfInventory", "vnic.EthNetworkPolicyInventory", "vnic.EthQosPolicyInventory", "vnic.EthVethInventory", "vnic.EthVnicInventory", "vnic.FcAdapterPolicyInventory", "vnic.FcIfInventory", "vnic.FcNetworkPolicyInventory", "vnic.FcQosPolicyInventory", "vnic.FcVethInventory", "vnic.FcVhbaPolicyInventory", "vnic.IscsiAdapterPolicyInventory", "vnic.IscsiBootPolicyInventory", "vnic.IscsiStaticTargetPolicyInventory", "vnic.LanConnectivityPolicyInventory", "vnic.SanConnectivityPolicyInventory", "vnic.ServiceEthIfInventory" ], "x-enum-as-string": true }, "DeviceMoId": { "description": "Device ID of the entity from where inventory is reported.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "policy.AbstractPendingChangeEval": { "title": "Policy Change Evaluation", "description": "A base abstract class that captures the details of a pending policy change evaluation.", "x-allOf-name": "policy.AbstractPendingChangeEval", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractPendingChangeEval', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.ProfilePendingChangeEval" ], "default": "server.ProfilePendingChangeEval", "x-enum-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.ProfilePendingChangeEval" ], "default": "server.ProfilePendingChangeEval", "x-enum-as-string": true }, "ChangeId": { "description": "Change id for which the evaluation is pending.", "type": "string", "readOnly": true, "x-omitempty": true }, "ChangedPolicy": { "$ref": "#/components/schemas/policy.AbstractPolicy.Relationship", "description": "A reference to a policyAbstractPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "policy.AbstractPolicy.Relationship": { "description": "A relationship to the 'policy.AbstractPolicy' resource, or the expanded 'policy.AbstractPolicy' resource, or the 'null' value.", "x-one-of-name": "policy.AbstractPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/policy.AbstractPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "policy.AbstractPolicy": { "title": "Policy", "description": "A base abstract class for all configuration policies that can be applied to service profiles.", "x-allOf-name": "policy.AbstractPolicy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractConfigurationObject" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "aaa.RetentionPolicy", "access.IpAddress", "access.Policy", "adapter.ConfigPolicy", "auditd.Policy", "bios.Policy", "boot.PrecisionPolicy", "certificatemanagement.Policy", "comm.HttpProxyPolicy", "compute.PcieConnectivityPolicy", "compute.ScrubPolicy", "compute.ServerPowerPolicy", "deviceconnector.Policy", "fabric.EthNetworkControlPolicy", "fabric.EthNetworkGroupPolicy", "fabric.EthNetworkPolicy", "fabric.FcNetworkPolicy", "fabric.FcZonePolicy", "fabric.FlowControlPolicy", "fabric.LinkAggregationPolicy", "fabric.LinkControlPolicy", "fabric.MacSecPolicy", "fabric.MulticastPolicy", "fabric.NetFlowPolicy", "fabric.PortPolicy", "fabric.SwitchControlPolicy", "fabric.SystemQosPolicy", "fcpool.Pool", "firmware.Policy", "hyperflex.AutoSupportPolicy", "hyperflex.ClusterBackupPolicy", "hyperflex.ClusterNetworkPolicy", "hyperflex.ClusterReplicationNetworkPolicy", "hyperflex.ClusterStoragePolicy", "hyperflex.ExtFcStoragePolicy", "hyperflex.ExtIscsiStoragePolicy", "hyperflex.LocalCredentialPolicy", "hyperflex.NodeConfigPolicy", "hyperflex.ProxySettingPolicy", "hyperflex.SoftwareVersionPolicy", "hyperflex.SysConfigPolicy", "hyperflex.UcsmConfigPolicy", "hyperflex.VcenterConfigPolicy", "iam.EndPointUserPolicy", "iam.LdapPolicy", "ipmioverlan.Policy", "ippool.Pool", "ippool.ShadowPool", "iqnpool.Pool", "kvm.Policy", "macpool.Pool", "memory.PersistentMemoryPolicy", "memory.Policy", "networkconfig.Policy", "ntp.Policy", "pool.IdMappingPolicy", "power.Policy", "recovery.BackupConfigPolicy", "recovery.OnDemandBackup", "recovery.ScheduleConfigPolicy", "resourcepool.ChassisQualificationPolicy", "resourcepool.Pool", "resourcepool.QualificationPolicy", "scheduler.SchedulePolicy", "sdcard.Policy", "smtp.Policy", "snmp.Policy", "sol.Policy", "ssh.Policy", "storage.DriveSecurityPolicy", "storage.StoragePolicy", "syslog.Policy", "thermal.Policy", "uuidpool.Pool", "vmedia.Policy", "vnic.EthAdapterPolicy", "vnic.EthNetworkPolicy", "vnic.EthQosPolicy", "vnic.FcAdapterPolicy", "vnic.FcNetworkPolicy", "vnic.FcQosPolicy", "vnic.IscsiAdapterPolicy", "vnic.IscsiBootPolicy", "vnic.IscsiStaticTargetPolicy", "vnic.LanConnectivityPolicy", "vnic.LanSettings", "vnic.SanConnectivityPolicy", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "aaa.RetentionPolicy", "access.IpAddress", "access.Policy", "adapter.ConfigPolicy", "auditd.Policy", "bios.Policy", "boot.PrecisionPolicy", "certificatemanagement.Policy", "comm.HttpProxyPolicy", "compute.PcieConnectivityPolicy", "compute.ScrubPolicy", "compute.ServerPowerPolicy", "deviceconnector.Policy", "fabric.EthNetworkControlPolicy", "fabric.EthNetworkGroupPolicy", "fabric.EthNetworkPolicy", "fabric.FcNetworkPolicy", "fabric.FcZonePolicy", "fabric.FlowControlPolicy", "fabric.LinkAggregationPolicy", "fabric.LinkControlPolicy", "fabric.MacSecPolicy", "fabric.MulticastPolicy", "fabric.NetFlowPolicy", "fabric.PortPolicy", "fabric.SwitchControlPolicy", "fabric.SystemQosPolicy", "fcpool.Pool", "firmware.Policy", "hyperflex.AutoSupportPolicy", "hyperflex.ClusterBackupPolicy", "hyperflex.ClusterNetworkPolicy", "hyperflex.ClusterReplicationNetworkPolicy", "hyperflex.ClusterStoragePolicy", "hyperflex.ExtFcStoragePolicy", "hyperflex.ExtIscsiStoragePolicy", "hyperflex.LocalCredentialPolicy", "hyperflex.NodeConfigPolicy", "hyperflex.ProxySettingPolicy", "hyperflex.SoftwareVersionPolicy", "hyperflex.SysConfigPolicy", "hyperflex.UcsmConfigPolicy", "hyperflex.VcenterConfigPolicy", "iam.EndPointUserPolicy", "iam.LdapPolicy", "ipmioverlan.Policy", "ippool.Pool", "ippool.ShadowPool", "iqnpool.Pool", "kvm.Policy", "macpool.Pool", "memory.PersistentMemoryPolicy", "memory.Policy", "networkconfig.Policy", "ntp.Policy", "pool.IdMappingPolicy", "power.Policy", "recovery.BackupConfigPolicy", "recovery.OnDemandBackup", "recovery.ScheduleConfigPolicy", "resourcepool.ChassisQualificationPolicy", "resourcepool.Pool", "resourcepool.QualificationPolicy", "scheduler.SchedulePolicy", "sdcard.Policy", "smtp.Policy", "snmp.Policy", "sol.Policy", "ssh.Policy", "storage.DriveSecurityPolicy", "storage.StoragePolicy", "syslog.Policy", "thermal.Policy", "uuidpool.Pool", "vmedia.Policy", "vnic.EthAdapterPolicy", "vnic.EthNetworkPolicy", "vnic.EthQosPolicy", "vnic.FcAdapterPolicy", "vnic.FcNetworkPolicy", "vnic.FcQosPolicy", "vnic.IscsiAdapterPolicy", "vnic.IscsiBootPolicy", "vnic.IscsiStaticTargetPolicy", "vnic.LanConnectivityPolicy", "vnic.LanSettings", "vnic.SanConnectivityPolicy", "vnic.SanSettings" ], "x-enum-as-string": true }, "Description": { "description": "Description of the policy.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "Name of the concrete policy.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true } } } ] }, "policy.AbstractPolicyInventory": { "title": "PolicyInventory", "description": "A base abstract class for all Inventoried policies that can be applied to profiles.", "x-allOf-name": "policy.AbstractPolicyInventory", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "access.PolicyInventory", "certificatemanagement.PolicyInventory", "compute.PcieConnectivityPolicyInventory", "fabric.EthNetworkControlPolicyInventory", "fabric.EthNetworkGroupPolicyInventory", "firmware.FirmwareSummary", "iam.EndPointUserPolicyInventory", "iam.LdapPolicyInventory", "ipmioverlan.PolicyInventory", "kvm.PolicyInventory", "memory.PolicyInventory", "networkconfig.PolicyInventory", "ntp.PolicyInventory", "power.PolicyInventory", "sdcard.PolicyInventory", "smtp.PolicyInventory", "snmp.PolicyInventory", "sol.PolicyInventory", "ssh.PolicyInventory", "syslog.PolicyInventory", "thermal.PolicyInventory", "vmedia.PolicyInventory", "vnic.EthAdapterPolicyInventory", "vnic.EthNetworkPolicyInventory", "vnic.EthQosPolicyInventory", "vnic.FcAdapterPolicyInventory", "vnic.FcNetworkPolicyInventory", "vnic.FcQosPolicyInventory", "vnic.IscsiAdapterPolicyInventory", "vnic.IscsiBootPolicyInventory", "vnic.IscsiStaticTargetPolicyInventory", "vnic.LanConnectivityPolicyInventory", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "access.PolicyInventory", "certificatemanagement.PolicyInventory", "compute.PcieConnectivityPolicyInventory", "fabric.EthNetworkControlPolicyInventory", "fabric.EthNetworkGroupPolicyInventory", "firmware.FirmwareSummary", "iam.EndPointUserPolicyInventory", "iam.LdapPolicyInventory", "ipmioverlan.PolicyInventory", "kvm.PolicyInventory", "memory.PolicyInventory", "networkconfig.PolicyInventory", "ntp.PolicyInventory", "power.PolicyInventory", "sdcard.PolicyInventory", "smtp.PolicyInventory", "snmp.PolicyInventory", "sol.PolicyInventory", "ssh.PolicyInventory", "syslog.PolicyInventory", "thermal.PolicyInventory", "vmedia.PolicyInventory", "vnic.EthAdapterPolicyInventory", "vnic.EthNetworkPolicyInventory", "vnic.EthQosPolicyInventory", "vnic.FcAdapterPolicyInventory", "vnic.FcNetworkPolicyInventory", "vnic.FcQosPolicyInventory", "vnic.IscsiAdapterPolicyInventory", "vnic.IscsiBootPolicyInventory", "vnic.IscsiStaticTargetPolicyInventory", "vnic.LanConnectivityPolicyInventory", "vnic.SanConnectivityPolicyInventory" ], "x-enum-as-string": true }, "Description": { "description": "Description of the policy.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\sa-zA-Z0-9_'.:-]*$", "maxLength": 1024, "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the inventoried policy object.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,512}$", "readOnly": true, "x-omitempty": true } } } ] }, "policy.AbstractPolicyItem": { "title": "PolicyItem", "description": "A base abstract class for all child MOs of a policy, eg. vNIC in LAN connectivity policy and vHBA in SAN connectivity policy.", "x-allOf-name": "policy.AbstractPolicyItem", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractConfigurationObject" } ] }, "policy.AbstractProfile.Relationship": { "description": "A relationship to the 'policy.AbstractProfile' resource, or the expanded 'policy.AbstractProfile' resource, or the 'null' value.", "x-one-of-name": "policy.AbstractProfile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/policy.AbstractProfile" } ], "discriminator": { "propertyName": "ClassId" } }, "policy.AbstractProfile": { "title": "Policy:Abstract Profile", "description": "Abstract base type for all profiles.", "x-allOf-name": "policy.AbstractProfile", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractConfigurationObject" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.AbstractProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.IomProfile", "chassis.Profile", "chassis.ProfileTemplate", "fabric.SwitchClusterProfile", "fabric.SwitchClusterProfileTemplate", "fabric.SwitchProfile", "fabric.SwitchProfileTemplate", "hyperflex.ClusterProfile", "hyperflex.NodeProfile", "recovery.BackupProfile", "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": [ "chassis.IomProfile", "chassis.Profile", "chassis.ProfileTemplate", "fabric.SwitchClusterProfile", "fabric.SwitchClusterProfileTemplate", "fabric.SwitchProfile", "fabric.SwitchProfileTemplate", "hyperflex.ClusterProfile", "hyperflex.NodeProfile", "recovery.BackupProfile", "server.Profile", "server.ProfileTemplate" ], "x-enum-as-string": true }, "Description": { "description": "Description of the profile.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "Name of the profile instance or profile template.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Type": { "description": "Defines the type of the profile. Accepted values are instance or template.\n* `instance` - The profile defines the configuration for a specific instance of a target.", "type": "string", "enum": [ "instance" ], "default": "instance", "x-omitempty": true }, "SrcTemplate": { "$ref": "#/components/schemas/policy.AbstractProfile.Relationship", "description": "A reference to a policyAbstractProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "policy.ActionParam": { "title": "Policy:Action Param", "description": "An action parameter setting as a key/value pair.", "x-allOf-name": "policy.ActionParam", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ActionParam', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ActionParam" ], "default": "policy.ActionParam", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ActionParam" ], "default": "policy.ActionParam", "x-enum-as-string": true }, "Name": { "description": "The action parameter identifier.", "type": "string", "x-omitempty": true }, "Value": { "description": "The action parameter value.", "type": "string", "x-omitempty": true } } } ] }, "policy.ActionQualifier": { "title": "Policy:Action Qualifier", "description": "Action qualifiers can be used to control actions that are performed on a profile object. For example - perform a 'Deploy' action only for specific policies.", "x-allOf-name": "policy.ActionQualifier", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "policy.ConfigChange": { "title": "Policy:Config Change", "description": "Defines the configuration changes at the summary level including configuration changes and disruptions.", "x-allOf-name": "policy.ConfigChange", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ConfigChange', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ConfigChange" ], "default": "policy.ConfigChange", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ConfigChange" ], "default": "policy.ConfigChange", "x-enum-as-string": true }, "Changes": { "type": "array", "items": { "description": "Configuration changes at summary level.", "type": "string", "x-omitempty": true }, "nullable": true }, "Disruptions": { "type": "array", "items": { "description": "Configuration disruptions.", "type": "string", "x-omitempty": true }, "nullable": true }, "PolicyDisruptions": { "type": "array", "items": { "description": "The types of configuration disruptions that occur when the policy is deployed.", "$ref": "#/components/schemas/policy.ConfigChangeDisruptionDetailType", "x-omitempty": true }, "nullable": true } } } ] }, "policy.ConfigChangeContext": { "title": "Policy:Config Change Context", "description": "Initial configuration state snapshot and configuration state.", "x-allOf-name": "policy.ConfigChangeContext", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ConfigChangeContext', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ConfigChangeContext" ], "default": "policy.ConfigChangeContext", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ConfigChangeContext" ], "default": "policy.ConfigChangeContext", "x-enum-as-string": true }, "ConfigChangeError": { "description": "Indicates reason for failure state of configChangeState.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigChangeState": { "description": "Indicates a profile's configuration change state. Used for tracking pending-changes and out-of-synch states.\n* `Ok` - Config change state represents Validation for change/drift is successful or is not applicable.\n* `Validating-change` - Config change state represents policy changes are being validated. This state starts when policy is changed and becomes different from deployed changes (Pending-changes).\n* `Validating-drift` - Config change state represents endpoint configuration changes are being validated. This state starts when endpoint is changed and endpoint configuration becomes different from policy configured changes (Out-of-sync).\n* `Change-failed` - Config change state represents there is internal error in calculating policy change.\n* `Drift-failed` - Config change state represents there is internal error in calculating endpoint configuraion drift.", "type": "string", "enum": [ "Ok", "Validating-change", "Validating-drift", "Change-failed", "Drift-failed" ], "default": "Ok", "readOnly": true, "x-omitempty": true }, "InitialConfigContext": { "description": "Stores initial Configuration state. Used for reverting back to initial state of ConfigContext in case of validation failure.", "$ref": "#/components/schemas/policy.ConfigContext", "readOnly": true, "x-omitempty": true } } } ] }, "policy.ConfigChangeDetailType": { "title": "Policy:Config Change Detail Type", "description": "Defines the details of a configuration change including change type, disruption and description of the change.", "x-allOf-name": "policy.ConfigChangeDetailType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ConfigChangeDetailType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ConfigChangeDetailType" ], "default": "policy.ConfigChangeDetailType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ConfigChangeDetailType" ], "default": "policy.ConfigChangeDetailType", "x-enum-as-string": true }, "Changes": { "type": "array", "items": { "description": "Type of the configuration change.", "type": "string", "x-omitempty": true }, "nullable": true }, "ConfigChangeContext": { "description": "Context information on the change.", "$ref": "#/components/schemas/policy.ConfigResultContext", "x-omitempty": true }, "ConfigChangeFlag": { "description": "Config change flag to differentiate Pending-changes and Config-drift.\n* `Pending-changes` - Config change flag represents changes are due to not deployed changes from Intersight.\n* `Drift-changes` - Config change flag represents changes are due to endpoint configuration changes.", "type": "string", "enum": [ "Pending-changes", "Drift-changes" ], "default": "Pending-changes", "x-omitempty": true }, "Disruptions": { "type": "array", "items": { "description": "Possible disruption the configuration change might cause.", "type": "string", "x-omitempty": true }, "nullable": true }, "Message": { "description": "Detailed description of the config change.", "type": "string", "x-omitempty": true }, "ModStatus": { "description": "Modification status of the mo in this config change.\n* `None` - The 'none' operation/state.Indicates a configuration profile has been deployed, and the desired configuration matches the actual device configuration.\n* `Created` - The 'create' operation/state.Indicates a configuration profile has been created and associated with a device, but the configuration specified in the profilehas not been applied yet. For example, this could happen when the user creates a server profile and has not deployed the profile yet.\n* `Modified` - The 'update' operation/state.Indicates some of the desired configuration changes specified in a profile have not been been applied to the associated device.This happens when the user has made changes to a profile and has not deployed the changes yet, or when the workflow to applythe configuration changes has not completed successfully.\n* `Deleted` - The 'delete' operation/state.Indicates a configuration profile has been been disassociated from a device and the user has not undeployed these changes yet.", "type": "string", "enum": [ "None", "Created", "Modified", "Deleted" ], "default": "None", "x-omitempty": true } } } ] }, "policy.ConfigChangeDisruptionDetailType": { "title": "Policy:Config Change Disruption Detail Type", "description": "Details of the configuration change that includes type and description of the change and the type of disruption.", "x-allOf-name": "policy.ConfigChangeDisruptionDetailType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ConfigChangeDisruptionDetailType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ConfigChangeDisruptionDetailType" ], "default": "policy.ConfigChangeDisruptionDetailType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ConfigChangeDisruptionDetailType" ], "default": "policy.ConfigChangeDisruptionDetailType", "x-enum-as-string": true }, "Disruptions": { "type": "array", "items": { "description": "Disruption caused by the configuration change.", "type": "string", "x-omitempty": true }, "nullable": true }, "IsOnlyRequiredByOtherPolicies": { "description": "The current policy has to be redeployed only because there are other policy changes that require this.", "type": "boolean", "x-omitempty": true }, "PolicyName": { "description": "Name of the policy that, when modified, causes the disruption.", "type": "string", "x-omitempty": true }, "PolicyPendingAction": { "description": "Name of the action which is pending on this policy. Example, if policy is not yet activated we mark this field as not-activated. Currently we support two actions, not-deployed and not-activated.", "type": "string", "x-omitempty": true }, "RequiredByPolicies": { "type": "array", "items": { "description": "List of policies that needs the current policy to be redeployed.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "policy.ConfigContext": { "title": "Policy:Config Context", "description": "Configuration related state and results.", "x-allOf-name": "policy.ConfigContext", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ConfigContext', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ConfigContext" ], "default": "policy.ConfigContext", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ConfigContext" ], "default": "policy.ConfigContext", "x-enum-as-string": true }, "ConfigState": { "description": "Indicates a profile's configuration deploying state. Values -- Assigned, Not-assigned, Associated, Pending-changes, Out-of-sync, Validating, Configuring, Failed.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigStateSummary": { "description": "Indicates a profile's configuration deploying state. Values -- Assigned, Not-assigned, Associated, InConsistent, Validating, Configuring, Failed, Activating, UnConfiguring.\n* `None` - The default state is none.\n* `Not-assigned` - Server is not assigned to the profile.\n* `Assigned` - Server is assigned to the profile and the configurations are not yet deployed.\n* `Preparing` - Preparing to deploy the configuration.\n* `Validating` - Profile validation in progress.\n* `Evaluating` - Policy edit configuration change evaluation in progress.\n* `Configuring` - Profile deploy operation is in progress.\n* `UnConfiguring` - Server is unassigned and config cleanup is in progress.\n* `Analyzing` - Profile changes are being analyzed.\n* `Activating` - Configuration is being activated at the endpoint.\n* `Inconsistent` - Profile is inconsistent with the endpoint configuration.\n* `Associated` - The profile configuration has been applied to the endpoint and no inconsistencies have been detected.\n* `Failed` - The last action on the profile has failed.\n* `Not-complete` - Config import operation on the profile is not complete.\n* `Waiting-for-resource` - Waiting for the resource to be allocated for the profile.\n* `Partially-deployed` - The profile configuration has been applied on a subset of endpoints.", "type": "string", "enum": [ "None", "Not-assigned", "Assigned", "Preparing", "Validating", "Evaluating", "Configuring", "UnConfiguring", "Analyzing", "Activating", "Inconsistent", "Associated", "Failed", "Not-complete", "Waiting-for-resource", "Partially-deployed" ], "default": "None", "readOnly": true, "x-omitempty": true }, "ConfigType": { "description": "The type of configuration running on the profile. Since profile deployments can configure multiple different settings, configType indicates which type of configuration is currently in progress.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControlAction": { "description": "System action to trigger the appropriate workflow. Values -- No_op, ConfigChange, Deploy, Unbind.", "type": "string", "x-omitempty": true }, "ErrorState": { "description": "Indicates a profile's error state. Values -- Validation-error (Static validation error), Pre-config-error (Runtime validation error), Config-error (Runtime configuration error).", "type": "string", "x-omitempty": true }, "InconsistencyReason": { "type": "array", "items": { "description": "The reason for the profile being in an inconsistent state. Value -- Pending-changes, Out-of-sync, Not Activated, Config-sync-failure.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Combined state (configState, and operational state of the associated physical resource) to indicate the current state of the profile. Values -- n/a, Power-off, Pending-changes, Configuring, Ok, Failed.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "policy.ConfigResultContext": { "title": "Policy:Config Result Context", "description": "The context for a validation/config result such as the related entity's name, type, MOID etc.", "x-allOf-name": "policy.ConfigResultContext", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ConfigResultContext', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ConfigResultContext" ], "default": "policy.ConfigResultContext", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ConfigResultContext" ], "default": "policy.ConfigResultContext", "x-enum-as-string": true }, "DependentPolicyList": { "type": "array", "items": { "description": "Dependent policies that require redeployment for this change.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "EntityData": { "description": "The data of the object present in config result context.", "nullable": true, "readOnly": true, "x-omitempty": true }, "EntityMoid": { "description": "The Moid of the object present in config result context.", "type": "string", "x-omitempty": true }, "EntityName": { "description": "The name of the object present in config result context.", "type": "string", "x-omitempty": true }, "EntityType": { "description": "The type of the object present in config result context.", "type": "string", "x-omitempty": true }, "ParentMoid": { "description": "The Moid of the parent object present in config result context.", "type": "string", "x-omitempty": true }, "ParentPolicyObjectType": { "description": "The type of the policy object associated with the profile.", "type": "string", "x-omitempty": true }, "ParentType": { "description": "The type of the parent object present in config result context.", "type": "string", "x-omitempty": true } } } ] }, "policy.PolicyContextHolder": { "title": "Policy:Policy Context Holder", "description": "To store the policy details along with the context for which the entry is established.", "x-allOf-name": "policy.PolicyContextHolder", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.PolicyContextHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.PolicyContextHolder" ], "default": "policy.PolicyContextHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.PolicyContextHolder" ], "default": "policy.PolicyContextHolder", "x-enum-as-string": true }, "EndPointContext": { "description": "Information about the endpoint to which it is applied.\n* `Server` - Configuration is applied to a server context.\n* `FI` - Configuration is applied to a Fabric Identifier (FI) context.\n* `IOM` - Configuration is applied to an Input/Output Module (IOM) context.", "type": "string", "enum": [ "Server", "FI", "IOM" ], "default": "Server", "readOnly": true, "x-omitempty": true }, "Policy": { "description": "The name of the policy for which entry is created.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "policy.PolicyError": { "title": "Policy:Policy Error", "description": "The PolicyError object captures errors that occur when adding or removing a policy from a profile or template. It is an integral part of policy management, providing detailed insights into error conditions and facilitating troubleshooting.\n#### Purpose\nPolicyError serves as a diagnostic tool capturing error details and aiding in error resolution. It enhances transparency and accountability in policy operations, ensuring effective management and compliance.\n#### Key Concepts\n- **Error Documentation:** Provides detailed error messages, supporting effective troubleshooting and resolution of policy-related issues.\n- **Error Typing:** Categorizes errors based on their origin, such as computation failures, and license validation errors.", "x-allOf-name": "policy.PolicyError", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.PolicyError', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.PolicyError" ], "default": "policy.PolicyError", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.PolicyError" ], "default": "policy.PolicyError", "x-enum-as-string": true }, "Message": { "description": "Localized message based on the locale setting of the user's context giving the policy error description.", "type": "string", "readOnly": true, "x-omitempty": true }, "SyncSource": { "description": "Sync operation for the sync source object has an error.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The error type indicating the point of failure like policy attach/detach, placement computation (LCP/SCP) or license validation (LCP/SCP Qos).\nValues -- attachErr, detachErr, computationErr, licenseErr, configSyncErr.\n* `none` - None is set as default value when there is no error and status is ok.\n* `attachErr` - Policy attach to profile failed.\n* `detachErr` - Policy detach to profile failed.\n* `computationErr` - Policy specific computation failed. For example, vNIC placement on Network Adapter in LanConnectivityPolicy.\n* `licenseErr` - Policy specific license enforcement failed. For example, Cos property in EthernetQoS policy which is a subpolicyof LanConnectivityPolicy requires Advantage License. But if the server attached to the Server Profile does not have anAdvantage License then the license enforcement check would fail during LanConnectivityPolicy validation.\n* `configSyncErr` - Policy sync with the template failed. For example, it's possible that the vNIC macpool configuration assigned to the template does not have enough free addresses.", "type": "string", "enum": [ "none", "attachErr", "detachErr", "computationErr", "licenseErr", "configSyncErr" ], "default": "none", "readOnly": true, "x-omitempty": true } } } ] }, "policy.PolicyStatus": { "title": "Policy:Policy Status", "description": "The status descriptor for any policy association or validation related to a profile/template.\nIt contains the policy details like moid and type and the status progress like validating,\nok or errored. In case of one or more errors, the error details are populated in errorMessages.", "x-allOf-name": "policy.PolicyStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.PolicyStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.PolicyStatus" ], "default": "policy.PolicyStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.PolicyStatus" ], "default": "policy.PolicyStatus", "x-enum-as-string": true }, "ErrorMessages": { "type": "array", "items": { "description": "The array of policy error messages to capture the multiple types of errors which may occur during policy association.", "$ref": "#/components/schemas/policy.PolicyError", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Moid": { "description": "The object identifier of the policy.", "type": "string", "readOnly": true, "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", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Indicates if the policy association or validation was successful or not. Values -- ok, errored, validating.\n* `ok` - The policy association or validation is successful.\n* `error` - The policy association or validation has failed.\n* `validating` - The policy association or validation is in progress.", "type": "string", "enum": [ "ok", "error", "validating" ], "default": "ok", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The object type of the policy.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "policy.Qualifier": { "title": "Policy:Qualifier", "description": "Qualifiers to control the action being triggered.", "x-allOf-name": "policy.Qualifier", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "policy.ReportedPolicyChange": { "title": "Policy:Reported Policy Change", "description": "A policy change that has been reported to a profile.", "x-allOf-name": "policy.ReportedPolicyChange", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ReportedPolicyChange', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ReportedPolicyChange" ], "default": "policy.ReportedPolicyChange", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ReportedPolicyChange" ], "default": "policy.ReportedPolicyChange", "x-enum-as-string": true }, "ChangeId": { "description": "The change evaluation identifier for which the change is reported.", "type": "string", "readOnly": true, "x-omitempty": true }, "ChangeStatus": { "description": "The status of policy change evaluation which has been reported.\n* `Initiated` - The status when policy change evaluation is triggered for a policy.\n* `Reported` - The status when policy change evaluation is reported for a policy.\n* `Failed` - The status when policy change evaluation report handling failed for a policy.", "type": "string", "enum": [ "Initiated", "Reported", "Failed" ], "default": "Initiated", "readOnly": true, "x-omitempty": true }, "PolicyType": { "description": "The type of policy for which the change has been reported.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "policy.ScheduledAction": { "title": "Policy:Scheduled Action", "description": "Scheduled Action enables the queuing of multiple profile actions to be executed sequentially. Each action in the sequence is executed only after the successful completion of the previous action. If any action in the sequence fails, execution is halted and the scheduled action is cleared.\nFor example, if a user wants to perform both \"deploy\" and \"activate\" actions, they can use a scheduled action to trigger this sequence. In this case, \"activate\" will execute only if \"deploy\" completes successfully. If \"deploy\" fails, \"activate\" will not be executed.\n#### Purpose\nThe purpose of the Scheduled Action feature is to enable users to automate the execution of multiple profile actions in a predefined sequence. This ensures that actions are performed in order, with each subsequent action dependent on the successful completion of the previous one, thus improving operational efficiency and consistency.\n#### Key Concepts\n- **Sequential Execution:** Actions are executed one after another, following the specified order.\n- **Dependency Handling:** Each action starts only after the successful completion of the preceding action.\n- **Failure Handling:** If any action fails, the remaining actions in the sequence are not executed and the scheduled action is cleared.\n- **Automation:** Users can automate complex workflows, such as deploying and activating profiles, using a single scheduled action.\n- **Atomic Operation:** Ensures the integrity of the sequence by preventing partial execution when a failure occurs.", "x-allOf-name": "policy.ScheduledAction", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'policy.ScheduledAction', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "policy.ScheduledAction" ], "default": "policy.ScheduledAction", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "policy.ScheduledAction" ], "default": "policy.ScheduledAction", "x-enum-as-string": true }, "Action": { "description": "Name of the action to be performed on the profile.", "type": "string", "x-omitempty": true }, "ActionQualifier": { "description": "Qualifiers to control the action being triggered. Action qualifiers are to be specified based on the type of disruptions that an action is to be restricted to. For example, trigger the 'Deploy' action to only perform network and management plane configurations.", "$ref": "#/components/schemas/policy.ActionQualifier", "x-omitempty": true }, "ProceedOnReboot": { "description": "ProceedOnReboot can be used to acknowledge server reboot while triggering deploy/activate.", "type": "boolean", "x-omitempty": true } } } ] }, "pool.AbstractBlock": { "title": "Pool:Abstract Block", "description": "Abstract base counters for a block of identifiers.", "x-allOf-name": "pool.AbstractBlock", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.AbstractBlock', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "fcpool.FcBlock", "ippool.ShadowBlock", "iqnpool.Block", "macpool.IdBlock", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.FcBlock", "ippool.ShadowBlock", "iqnpool.Block", "macpool.IdBlock", "uuidpool.Block" ], "x-enum-as-string": true }, "FreeBlockCount": { "description": "Free IDs that can be allocated in this block.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NextIdAllocator": { "description": "Moving counter to allocate the next identifier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IdMappingPolicy": { "$ref": "#/components/schemas/pool.IdMappingPolicy.Relationship", "description": "A reference to a poolIdMappingPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pool.AbstractBlockLease": { "title": "Pool:Abstract Block Lease", "description": "BlockLease represents a block of address that is allocated from a pool to a specific entity like server profile/ vNic's or vhba's.", "x-allOf-name": "pool.AbstractBlockLease", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.AbstractBlockLease', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "ippool.BlockLease" ], "default": "ippool.BlockLease", "x-enum-as-string": true }, "Count": { "description": "Count of number of leases requested.", "type": "integer", "format": "int64", "minimum": 1, "x-omitempty": true } } } ] }, "pool.AbstractBlockType": { "title": "Pool:Abstract Block Type", "description": "Abstract base class for a block of identifiers.", "x-allOf-name": "pool.AbstractBlockType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.AbstractBlockType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "fcpool.Block", "ippool.IpV4Block", "ippool.IpV6Block", "iqnpool.IqnSuffixBlock", "macpool.Block", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.Block", "ippool.IpV4Block", "ippool.IpV6Block", "iqnpool.IqnSuffixBlock", "macpool.Block", "uuidpool.UuidBlock" ], "x-enum-as-string": true }, "Size": { "description": "Number of identifiers this block can hold.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 1024, "x-createOnly": true, "x-omitempty": true } } } ] }, "pool.AbstractIdPoolMember": { "title": "Pool:Abstract Id Pool Member", "description": "A single member of an identity pool such as IP, MAC, UUID etc.", "x-allOf-name": "pool.AbstractIdPoolMember", "allOf": [ { "$ref": "#/components/schemas/pool.AbstractPoolMember" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.AbstractIdPoolMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "fcpool.PoolMember", "ippool.PoolMember", "iqnpool.PoolMember", "macpool.PoolMember", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.PoolMember", "ippool.PoolMember", "iqnpool.PoolMember", "macpool.PoolMember", "uuidpool.PoolMember" ], "x-enum-as-string": true }, "AssignedByAnother": { "description": "Boolean to represent whether the ID is used either statically or by another pool.", "type": "boolean", "default": false, "x-omitempty": true }, "Reserved": { "description": "Boolean to represent whether the ID is reserved.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "pool.AbstractLease": { "title": "Pool:Abstract Lease", "description": "Concrete Children of Abstract Lease represent a single ID that is part of an ID universe. Concrete Children of this class will implement ID request action.", "x-allOf-name": "pool.AbstractLease", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.AbstractLease', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "fcpool.Lease", "ippool.IpLease", "iqnpool.Lease", "macpool.Lease", "resourcepool.Lease", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.Lease", "ippool.IpLease", "iqnpool.Lease", "macpool.Lease", "resourcepool.Lease", "uuidpool.UuidLease" ], "x-enum-as-string": true }, "AllocationType": { "description": "Type of the lease allocation either static or dynamic (i.e via pool).\n* `dynamic` - Identifiers to be allocated by system.\n* `static` - Identifiers are assigned by the user.", "type": "string", "enum": [ "dynamic", "static" ], "default": "dynamic", "x-omitempty": true }, "HasDuplicate": { "description": "HasDuplicate represents if there are other pools in which this id exists.", "type": "boolean", "default": false, "x-omitempty": true }, "Migrate": { "description": "The migration capability is applicable only for dynamic lease requests and it works in conjunction with preferred ID. If there is an existing dynamic or static lease that matches the preferred ID, that existing lease will be migrated to the current pool. That means the existing lease will be deleted and a new lease will be created in the pool. If there is a reservation exists that matches with preferred ID, that reservation will be kept as is and next available ID from the pool will be leased.", "type": "boolean", "default": false, "x-createOnly": true, "x-omitempty": true } } } ] }, "pool.AbstractPool": { "title": "Pool:Abstract Pool", "description": "Pool represents a collection of identifiers that can be allocated to server profiles.", "x-allOf-name": "pool.AbstractPool", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.AbstractPool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "fcpool.Pool", "ippool.Pool", "ippool.ShadowPool", "iqnpool.Pool", "macpool.Pool", "resourcepool.Pool", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.Pool", "ippool.Pool", "ippool.ShadowPool", "iqnpool.Pool", "macpool.Pool", "resourcepool.Pool", "uuidpool.Pool" ], "x-enum-as-string": true }, "Assigned": { "description": "Number of IDs that are currently assigned (in use).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AssignmentOrder": { "description": "Property is deprecated. Sequential is the only assignment order supported.\n* `sequential` - Identifiers are assigned in a sequential order.\n* `default` - Assignment order is decided by the system.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "enum": [ "sequential", "default" ], "default": "sequential", "x-omitempty": true }, "Reserved": { "description": "Number of IDs that are currently reserved (and not in use).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Size": { "description": "Total number of identifiers in this pool.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "pool.AbstractPoolMember": { "title": "Pool:Abstract Pool Member", "description": "A single entity that is part of a pool like a resource in a resource pool or an ID in an identity pool such as IP, MAC, UUID etc.", "x-allOf-name": "pool.AbstractPoolMember", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.AbstractPoolMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "fcpool.PoolMember", "ippool.PoolMember", "iqnpool.PoolMember", "macpool.PoolMember", "resourcepool.PoolMember", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.PoolMember", "ippool.PoolMember", "iqnpool.PoolMember", "macpool.PoolMember", "resourcepool.PoolMember", "uuidpool.PoolMember" ], "x-enum-as-string": true }, "Assigned": { "description": "Boolean to represent whether the ID is in use.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "pool.IdMappingMember.Response": { "description": "The response body of a HTTP GET request for the 'pool.IdMappingMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pool.IdMappingMember' resources.", "x-one-of-name": "pool.IdMappingMember.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pool.IdMappingMember.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pool.IdMappingMember": { "title": "Pool:Id Mapping Member", "description": "A resolved member of the ID mapping policy.", "x-allOf-name": "pool.IdMappingMember", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.IdMappingMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pool.IdMappingMember" ], "default": "pool.IdMappingMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pool.IdMappingMember" ], "default": "pool.IdMappingMember", "x-enum-as-string": true }, "IdMappingPolicy": { "$ref": "#/components/schemas/pool.IdMappingPolicy.Relationship", "description": "A reference to a poolIdMappingPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "#/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 } } } ] }, "pool.IdMappingMember.List": { "title": "List of 'pool.IdMappingMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pool.IdMappingMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pool.IdMappingMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pool.IdMappingMember" }, "nullable": true } } } ] }, "pool.IdMappingPolicy.Response": { "description": "The response body of a HTTP GET request for the 'pool.IdMappingPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pool.IdMappingPolicy' resources.", "x-one-of-name": "pool.IdMappingPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pool.IdMappingPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pool.IdMappingPolicy.Relationship": { "description": "A relationship to the 'pool.IdMappingPolicy' resource, or the expanded 'pool.IdMappingPolicy' resource, or the 'null' value.", "x-one-of-name": "pool.IdMappingPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pool.IdMappingPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "pool.IdMappingPolicy": { "title": "Pool:Id Mapping Policy", "description": "A policy to define a grouping of deployment targets (resource groups and organizations) which can be mapped to ID blocks.", "x-allOf-name": "pool.IdMappingPolicy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.IdMappingPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pool.IdMappingPolicy" ], "default": "pool.IdMappingPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pool.IdMappingPolicy" ], "default": "pool.IdMappingPolicy", "x-enum-as-string": true }, "ExportedSelectors": { "type": "array", "items": { "description": "Selectors that are exported during a backup operation and later applied during post-restore actions. These selectors have their MOID references removed and are transformed for export compatibility.", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "PerTypeCombinedSelector": { "type": "array", "items": { "description": "A single filter expression created by OR'ing the $filter criteria of the 'selectors' of a given object type. Used to efficiently maintain the membership of the ID mapping policy. This filter is maintained per object type in this type.", "$ref": "#/components/schemas/resource.PerTypeCombinedSelector", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Selectors": { "type": "array", "items": { "description": "A list of OData filters to select the deployment targets (organizations and resource groups).", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "UsageCount": { "description": "The number of ID pools to which this ID mapping policy is attached.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/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.IdMappingPolicy.List": { "title": "List of 'pool.IdMappingPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pool.IdMappingPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pool.IdMappingPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pool.IdMappingPolicy" }, "nullable": true } } } ] }, "pool.Reservation": { "title": "Pool:Reservation", "description": "Reservation object holding reserved identity information.", "x-allOf-name": "pool.Reservation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.Reservation", "ippool.Reservation", "iqnpool.Reservation", "macpool.Reservation", "resourcepool.Reservation", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.Reservation", "ippool.Reservation", "iqnpool.Reservation", "macpool.Reservation", "resourcepool.Reservation", "uuidpool.Reservation" ], "x-enum-as-string": true }, "AllocationType": { "description": "Type of the allocation for the identity in the reservation either static or dynamic (i.e. via pool).\n* `dynamic` - Identifiers to be allocated by system.\n* `static` - Identifiers are assigned by the user.", "type": "string", "enum": [ "dynamic", "static" ], "default": "dynamic", "x-omitempty": true } } } ] }, "pool.ReservationReference": { "title": "Pool:Reservation Reference", "description": "A reference to reservation object that needs to be used while allocating an identity.", "x-allOf-name": "pool.ReservationReference", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'pool.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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.ReservationReference", "ippool.ReservationReference", "iqnpool.ReservationReference", "macpool.ReservationReference", "resourcepool.ReservationReference", "uuidpool.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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "fcpool.ReservationReference", "ippool.ReservationReference", "iqnpool.ReservationReference", "macpool.ReservationReference", "resourcepool.ReservationReference", "uuidpool.ReservationReference" ], "x-enum-as-string": true }, "ReservationId": { "description": "The identity for which the reference is created. It is used to store the ID allocated to the profile during export. \nReservation id and Reservation moid are mutually exclusive and during export only reservationid will be populated.\nDuring import, If necessary reservation will be created based on reservationId and reservationMoid will be populated in the reference.\nFor IP and UUid IDs, we create reservation, for other Ids we do not create reservations.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ReservationMoid": { "description": "The moid of the reservation object.", "type": "string", "x-createOnly": true, "x-omitempty": true } } } ] }, "recovery.AbstractBackupConfig": { "title": "Backup Policy", "description": "Base Backup configuration for local or remote server.", "x-allOf-name": "recovery.AbstractBackupConfig", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.AbstractBackupConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "recovery.BackupConfigPolicy", "recovery.OnDemandBackup" ], "x-enum-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": [ "recovery.BackupConfigPolicy", "recovery.OnDemandBackup" ], "x-enum-as-string": true }, "FileNamePrefix": { "description": "Backup image file name prefix with timestamp (e.g., prefix-1572431305418).", "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 }, "LocationType": { "description": "Backup storage location (local or remote).\n* `Network Share` - Backup is stored remotely on a separate server.\n* `Local Storage` - Backup is stored locally on endpoint.", "type": "string", "enum": [ "Network Share", "Local Storage" ], "default": "Network Share", "x-omitempty": true }, "Password": { "description": "The backup server password.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Path": { "description": "File system path for storing backup images, including IP address/hostname (e.g., 172.29.109.234/var/backups/).", "type": "string", "x-omitempty": true }, "Protocol": { "description": "Protocol for backup transfer to network share.\n* `SCP` - Secure Copy Protocol (SCP) to access file server.\n* `SFTP` - SSH File Transfer Protocol (SFTP) to access file server.\n* `FTP` - File Transfer Protocol (FTP) to access file server.", "type": "string", "enum": [ "SCP", "SFTP", "FTP" ], "default": "SCP", "x-omitempty": true }, "RetentionCount": { "description": "Number of backup copies maintained on local or remote server (older backups overwritten).", "type": "integer", "format": "int64", "default": 10, "minimum": 1, "maximum": 365, "x-omitempty": true }, "UserName": { "description": "The backup server username.", "type": "string", "x-omitempty": true } } } ] }, "recovery.AbstractBackupInfo.Relationship": { "description": "A relationship to the 'recovery.AbstractBackupInfo' resource, or the expanded 'recovery.AbstractBackupInfo' resource, or the 'null' value.", "x-one-of-name": "recovery.AbstractBackupInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/recovery.AbstractBackupInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "recovery.AbstractBackupInfo": { "title": "Recovery:Abstract Backup Info", "description": "Abstract class for backup objects of all devices.", "x-allOf-name": "recovery.AbstractBackupInfo", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.AbstractBackupInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "ucsd.BackupInfo" ], "default": "ucsd.BackupInfo", "x-enum-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": [ "ucsd.BackupInfo" ], "default": "ucsd.BackupInfo", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "recovery.BackupConfigPolicy.Response": { "description": "The response body of a HTTP GET request for the 'recovery.BackupConfigPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'recovery.BackupConfigPolicy' resources.", "x-one-of-name": "recovery.BackupConfigPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/recovery.BackupConfigPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "recovery.BackupConfigPolicy.Relationship": { "description": "A relationship to the 'recovery.BackupConfigPolicy' resource, or the expanded 'recovery.BackupConfigPolicy' resource, or the 'null' value.", "x-one-of-name": "recovery.BackupConfigPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/recovery.BackupConfigPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "recovery.BackupConfigPolicy": { "title": "Backup Policy", "description": "The BackupConfigPolicy object defines comprehensive backup policies for local or remote servers. This provides the necessary inputs and configurations to execute backup operations effectively.\n#### Purpose\nThe BackupConfigPolicy object defines the rules and configurations for executing backups on designated servers. It coordinates backup profiles and ensures alignment with organizational strategies, providing a structured and consistent approach to managing backup operations.\n#### Key Concepts\n- **Centralized Control:** Facilitates the management of backup profiles under a unified policy framework.\n- **Access Control:** Ensures that only authorized personnel can define, read, or update backup policies.\n- **Relationship Management:** Maintains connections to backup profiles, promoting consistency and comprehensive policy application.", "x-allOf-name": "recovery.BackupConfigPolicy", "allOf": [ { "$ref": "#/components/schemas/recovery.AbstractBackupConfig" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.BackupConfigPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "recovery.BackupConfigPolicy" ], "default": "recovery.BackupConfigPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "recovery.BackupConfigPolicy" ], "default": "recovery.BackupConfigPolicy", "x-enum-as-string": true }, "BackupProfiles": { "description": "An array of relationships to recoveryBackupProfile resources.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.BackupProfile.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/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 } } } ] }, "recovery.BackupConfigPolicy.List": { "title": "List of 'recovery.BackupConfigPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'recovery.BackupConfigPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'recovery.BackupConfigPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.BackupConfigPolicy" }, "nullable": true } } } ] }, "recovery.BackupProfile.Response": { "description": "The response body of a HTTP GET request for the 'recovery.BackupProfile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'recovery.BackupProfile' resources.", "x-one-of-name": "recovery.BackupProfile.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/recovery.BackupProfile.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "recovery.BackupProfile.Relationship": { "description": "A relationship to the 'recovery.BackupProfile' resource, or the expanded 'recovery.BackupProfile' resource, or the 'null' value.", "x-one-of-name": "recovery.BackupProfile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/recovery.BackupProfile" } ], "discriminator": { "propertyName": "ClassId" } }, "recovery.BackupProfile": { "title": "BackupProfile", "description": "The BackupProfile object serves as the cornerstone for managing backup configurations on endpoints. It defines the parameters and conditions under which backups are conducted, supporting both scheduled and on-demand operations.\n#### Purpose\nThe BackupProfile object defines and manages backup configurations for endpoints. It allows setting up backup parameters, including scheduling and execution details, and enables or disables backup operations as needed to ensure systematic data protection, integrity, and availability.\n#### Key Concepts\n- **Flexibility:** Allows for both on-demand and scheduled backups, catering to diverse operational requirements.\n- **Versioning and Validation:** Supports robust validation mechanisms to ensure the accuracy and reliability of backup configurations.\n- **Relationship Management:** Links to device registrations and configuration results to maintain a comprehensive backup strategy.", "x-allOf-name": "recovery.BackupProfile", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractConfigProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.BackupProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "recovery.BackupProfile" ], "default": "recovery.BackupProfile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "recovery.BackupProfile" ], "default": "recovery.BackupProfile", "x-enum-as-string": true }, "Enabled": { "description": "Enables/Disables the schedule on the endpoint.", "type": "boolean", "default": true, "x-omitempty": true }, "BackupConfig": { "$ref": "#/components/schemas/recovery.BackupConfigPolicy.Relationship", "description": "A reference to a recoveryBackupConfigPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ConfigResult": { "$ref": "#/components/schemas/recovery.ConfigResult.Relationship", "description": "A reference to a recoveryConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DeviceId": { "$ref": "#/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." }, "Organization": { "$ref": "#/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 }, "ScheduleConfig": { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy.Relationship", "description": "A reference to a recoveryScheduleConfigPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "recovery.BackupProfile.List": { "title": "List of 'recovery.BackupProfile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'recovery.BackupProfile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'recovery.BackupProfile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.BackupProfile" }, "nullable": true } } } ] }, "recovery.BackupSchedule": { "title": "Recovery:Backup Schedule", "description": "Backup settings for user defined scheduling on endpoint.", "x-allOf-name": "recovery.BackupSchedule", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.BackupSchedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "recovery.BackupSchedule" ], "default": "recovery.BackupSchedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "recovery.BackupSchedule" ], "default": "recovery.BackupSchedule", "x-enum-as-string": true }, "ExecutionTime": { "description": "The daily backup run time.", "type": "string", "format": "date-time", "x-omitempty": true }, "FrequencyUnit": { "description": "Backup schedule frequency.\n* `Daily` - Daily backup scheduling option.\n* `Periodic` - Hourly backup scheduling option.", "type": "string", "enum": [ "Daily", "Periodic" ], "default": "Daily", "x-omitempty": true }, "Hours": { "description": "Back schedule frequency (in hours).\n* `8` - The backup interval is 8 hours.\n* `4` - The backup interval is 4 hours.\n* `12` - The backup interval is 12 hours.\n* `16` - The backup interval is 16 hours.\n* `20` - The backup interval is 20 hours.", "type": "integer", "enum": [ 8, 4, 12, 16, 20 ], "default": 8, "x-omitempty": true } } } ] }, "recovery.ConfigParams": { "title": "Recovery:Config Params", "description": "Restore workflows configuration parameters.", "x-allOf-name": "recovery.ConfigParams", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "recovery.ConfigResult.Response": { "description": "The response body of a HTTP GET request for the 'recovery.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 'recovery.ConfigResult' resources.", "x-one-of-name": "recovery.ConfigResult.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/recovery.ConfigResult.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "recovery.ConfigResult.Relationship": { "description": "A relationship to the 'recovery.ConfigResult' resource, or the expanded 'recovery.ConfigResult' resource, or the 'null' value.", "x-one-of-name": "recovery.ConfigResult.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/recovery.ConfigResult" } ], "discriminator": { "propertyName": "ClassId" } }, "recovery.ConfigResult": { "title": "Recovery:Config Result", "description": "Profile configuration (deploy, validation) results with overall state and detailed message.", "x-allOf-name": "recovery.ConfigResult", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractConfigResult" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.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": [ "recovery.ConfigResult" ], "default": "recovery.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": [ "recovery.ConfigResult" ], "default": "recovery.ConfigResult", "x-enum-as-string": true }, "BackupProfile": { "$ref": "#/components/schemas/recovery.BackupProfile.Relationship", "description": "A reference to a recoveryBackupProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ResultEntries": { "description": "An array of relationships to recoveryConfigResultEntry resources.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.ConfigResultEntry.Relationship" }, "nullable": true } } } ] }, "recovery.ConfigResult.List": { "title": "List of 'recovery.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'recovery.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 'recovery.ConfigResult' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.ConfigResult" }, "nullable": true } } } ] }, "recovery.ConfigResultEntry.Response": { "description": "The response body of a HTTP GET request for the 'recovery.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 'recovery.ConfigResultEntry' resources.", "x-one-of-name": "recovery.ConfigResultEntry.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/recovery.ConfigResultEntry.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "recovery.ConfigResultEntry.Relationship": { "description": "A relationship to the 'recovery.ConfigResultEntry' resource, or the expanded 'recovery.ConfigResultEntry' resource, or the 'null' value.", "x-one-of-name": "recovery.ConfigResultEntry.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/recovery.ConfigResultEntry" } ], "discriminator": { "propertyName": "ClassId" } }, "recovery.ConfigResultEntry": { "title": "Recovery:Config Result Entry", "description": "Backup profile state result entry on end device.", "x-allOf-name": "recovery.ConfigResultEntry", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractConfigResultEntry" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.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": [ "recovery.ConfigResultEntry" ], "default": "recovery.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": [ "recovery.ConfigResultEntry" ], "default": "recovery.ConfigResultEntry", "x-enum-as-string": true }, "ConfigResult": { "$ref": "#/components/schemas/recovery.ConfigResult.Relationship", "description": "A reference to a recoveryConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "recovery.ConfigResultEntry.List": { "title": "List of 'recovery.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'recovery.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 'recovery.ConfigResultEntry' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.ConfigResultEntry" }, "nullable": true } } } ] }, "recovery.OnDemandBackup.Response": { "description": "The response body of a HTTP GET request for the 'recovery.OnDemandBackup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'recovery.OnDemandBackup' resources.", "x-one-of-name": "recovery.OnDemandBackup.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/recovery.OnDemandBackup.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "recovery.OnDemandBackup": { "title": "On Demand Backup", "description": "The OnDemandBackup object is tailored for initiating and managing immediate backup operations on endpoints. It caters to scenarios requiring quick and responsive data protection measures.\n#### Purpose\nThe OnDemandBackup object enables immediate, unscheduled backup operations tailored to current needs and conditions. It ensures swift and effective execution of backups, supporting urgent and flexible data protection requirements.\n#### Key Concepts\n- **Flexibility:** Provides mechanisms for instant backup execution, enhancing responsiveness to changing conditions.\n- **Access Control:** Implements privilege sets to restrict execution to authorized users.\n- **Relationship Management:** Integrates with device registration systems to maintain a seamless backup operation framework.", "x-allOf-name": "recovery.OnDemandBackup", "allOf": [ { "$ref": "#/components/schemas/recovery.AbstractBackupConfig" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.OnDemandBackup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "recovery.OnDemandBackup" ], "default": "recovery.OnDemandBackup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "recovery.OnDemandBackup" ], "default": "recovery.OnDemandBackup", "x-enum-as-string": true }, "ConfigResult": { "$ref": "#/components/schemas/recovery.ConfigResult.Relationship", "description": "A reference to a recoveryConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DeviceId": { "$ref": "#/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." }, "Organization": { "$ref": "#/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 } } } ] }, "recovery.OnDemandBackup.List": { "title": "List of 'recovery.OnDemandBackup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'recovery.OnDemandBackup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'recovery.OnDemandBackup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.OnDemandBackup" }, "nullable": true } } } ] }, "recovery.Restore.Response": { "description": "The response body of a HTTP GET request for the 'recovery.Restore' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'recovery.Restore' resources.", "x-one-of-name": "recovery.Restore.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/recovery.Restore.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "recovery.Restore": { "title": "Restore", "description": "The Restore object is a critical component of the backup and restoration framework, focusing on the execution and management of restore operations on various instances of UCS Director only. This provides a structured approach to trigger and monitor restore workflows, ensuring efficient recovery processes.\n#### Purpose\nThe Restore object initiates and tracks restore operations on target endpoints. It facilitates the start of restore workflows and provides mechanisms to monitor their progress and status, ensuring smooth execution and reliable system recovery.\n#### Key Concepts\n- **Workflow Integration:** The Restore object is closely integrated with workflow systems, allowing for automated execution and tracking of restore processes.\n- **Access Control:** Implemented with privilege sets to ensure that only authorized users can initiate, read, or update restore operations.\n- **Relationship Management:** Establishes connections with related objects, such as device registration and workflow instances, to maintain a cohesive recovery strategy.", "x-allOf-name": "recovery.Restore", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.Restore', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "recovery.Restore" ], "default": "recovery.Restore", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "recovery.Restore" ], "default": "recovery.Restore", "x-enum-as-string": true }, "ConfigParams": { "description": "Resource workflow configuration parameters.", "$ref": "#/components/schemas/recovery.ConfigParams", "x-omitempty": true }, "BackupInfo": { "$ref": "#/components/schemas/recovery.AbstractBackupInfo.Relationship", "description": "A reference to a recoveryAbstractBackupInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Device": { "$ref": "#/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." }, "Organization": { "$ref": "#/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 }, "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 } } } ] }, "recovery.Restore.List": { "title": "List of 'recovery.Restore' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'recovery.Restore' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'recovery.Restore' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.Restore" }, "nullable": true } } } ] }, "recovery.ScheduleConfigPolicy.Response": { "description": "The response body of a HTTP GET request for the 'recovery.ScheduleConfigPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'recovery.ScheduleConfigPolicy' resources.", "x-one-of-name": "recovery.ScheduleConfigPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "recovery.ScheduleConfigPolicy.Relationship": { "description": "A relationship to the 'recovery.ScheduleConfigPolicy' resource, or the expanded 'recovery.ScheduleConfigPolicy' resource, or the 'null' value.", "x-one-of-name": "recovery.ScheduleConfigPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "recovery.ScheduleConfigPolicy": { "title": "Schedule Policy", "description": "The ScheduleConfigPolicy object is integral to defining and managing scheduled backup operations on both local and remote servers. It establishes the parameters for regular data protection processes.\n#### Purpose\nThe ScheduleConfigPolicy object manages and coordinates backup schedules for target devices. It defines the frequency and timing of backups in line with organizational policies, ensuring structured scheduling that enhances the reliability and efficiency of backup operations.\n#### Key Concepts\n- **Consistency:** Ensures regular and predictable backup operations, reducing the risk of data loss.\n- **Access Control:** Restricts scheduling capabilities to authorized users, safeguarding operational integrity.\n- **Relationship Management:** Links to backup profiles, promoting comprehensive backup scheduling strategies.", "x-allOf-name": "recovery.ScheduleConfigPolicy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'recovery.ScheduleConfigPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "recovery.ScheduleConfigPolicy" ], "default": "recovery.ScheduleConfigPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "recovery.ScheduleConfigPolicy" ], "default": "recovery.ScheduleConfigPolicy", "x-enum-as-string": true }, "Schedule": { "description": "Backup schedule for target device (4 to 1440 hours).", "$ref": "#/components/schemas/recovery.BackupSchedule", "x-omitempty": true }, "BackupProfiles": { "description": "An array of relationships to recoveryBackupProfile resources.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.BackupProfile.Relationship" }, "nullable": true }, "Organization": { "$ref": "#/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 } } } ] }, "recovery.ScheduleConfigPolicy.List": { "title": "List of 'recovery.ScheduleConfigPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'recovery.ScheduleConfigPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'recovery.ScheduleConfigPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/recovery.ScheduleConfigPolicy" }, "nullable": true } } } ] }, "resource.AbstractReservation": { "title": "Resource:Abstract Reservation", "description": "You can reserve resources for use cases related to Pools or Groups. For example, resources that are decommissioned or reserved for future allocation are maintained in the Reservation model, where AbstractReservation serves as the base class for reservations.", "x-allOf-name": "resource.AbstractReservation", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.AbstractReservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "resource.Reservation", "resourcepool.MembershipReservation" ], "x-enum-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": [ "resource.Reservation", "resourcepool.MembershipReservation" ], "x-enum-as-string": true }, "Description": { "description": "Details of the use case for which the reservation was created, such as decommissioning.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Expiration": { "description": "The resource reservation includes an expiration date and a timestamp indicating when this management object will be cleared. The expiration date is set during the decommissioning process and is maintained for a period of 3 months.", "type": "string", "format": "date-time", "x-createOnly": true, "x-omitempty": true }, "ReservationSelector": { "description": "The unique identification of the resource is based on the resource OData string, which is mentioned as part of the ReservationSelector. For example, 'Serial eq 'EM6259AE6B'.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ResourceType": { "description": "The type of resource that is placed into resource groups or pools. Resource Type can be either 'compute.Blade' or 'compute.RackUnit' for pools.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Status": { "description": "The reservation status can be in the 'Created', 'Processing', 'Failed', or 'Finished' state.\n* `Created` - By default, a reservation is in Created status.\n* `Processing` - A reservation is changed to Processing status for appliance mode resource claim requests.\n* `Failed` - A reservation is changed to Failed status if the validations on resources, resource groups fails.\n* `Finished` - A reservation is changed to Finished status if the validations on resources, resource groups are successful. The resource moids in reservation will be added to resource groups using OData filters.", "type": "string", "enum": [ "Created", "Processing", "Failed", "Finished" ], "default": "Created", "readOnly": true, "x-omitempty": true }, "Identity": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "resource.AbstractResourceQualificationPolicy.Relationship": { "description": "A relationship to the 'resource.AbstractResourceQualificationPolicy' resource, or the expanded 'resource.AbstractResourceQualificationPolicy' resource, or the 'null' value.", "x-one-of-name": "resource.AbstractResourceQualificationPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resource.AbstractResourceQualificationPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "resource.AbstractResourceQualificationPolicy": { "title": "Resource:Abstract Resource Qualification Policy", "description": "The base QualificationPolicy extends from AbstractPolicy; all qualification policies will be derived from this class. For example, ServerPoolQualificationPolicy.", "x-allOf-name": "resource.AbstractResourceQualificationPolicy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.AbstractResourceQualificationPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "resourcepool.ChassisQualificationPolicy", "resourcepool.QualificationPolicy" ], "x-enum-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": [ "resourcepool.ChassisQualificationPolicy", "resourcepool.QualificationPolicy" ], "x-enum-as-string": true }, "Qualifiers": { "type": "array", "items": { "description": "Set of conditions to qualify the servers.", "$ref": "#/components/schemas/resource.ResourceQualifier", "x-omitempty": true }, "nullable": true } } } ] }, "resource.AdaptorsRangeFilter": { "title": "Adaptors Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum adaptors value.", "x-allOf-name": "resource.AdaptorsRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.AdaptorsRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.AdaptorsRangeFilter" ], "default": "resource.AdaptorsRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.AdaptorsRangeFilter" ], "default": "resource.AdaptorsRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 16, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 16, "x-omitempty": true } } } ] }, "resource.AdvancedFilter": { "title": "Advanced Filter", "description": "Advanced filter property holder.", "x-allOf-name": "resource.AdvancedFilter", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.AdvancedFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "resource.AdaptorsRangeFilter", "resource.ChassisIdRangeFilter", "resource.CpuCoreRangeFilter", "resource.CpuSpeedRangeFilter", "resource.GpuControllersRangeFilter", "resource.MemoryCapacityRangeFilter", "resource.MemoryUnitsRangeFilter", "resource.RackIdRangeFilter", "resource.SlotIdRangeFilter" ], "x-enum-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": [ "resource.AdaptorsRangeFilter", "resource.ChassisIdRangeFilter", "resource.CpuCoreRangeFilter", "resource.CpuSpeedRangeFilter", "resource.GpuControllersRangeFilter", "resource.MemoryCapacityRangeFilter", "resource.MemoryUnitsRangeFilter", "resource.RackIdRangeFilter", "resource.SlotIdRangeFilter" ], "x-enum-as-string": true }, "ConditionType": { "description": "Filter condition to extract the resource.\n* `RANGE` - Condition matches with range over value.", "type": "string", "enum": [ "RANGE" ], "default": "RANGE", "x-omitempty": true } } } ] }, "resource.BladeQualifier": { "title": "Blade Qualifier", "description": "The BladeQualifier object is focused on qualifying blade servers based on various chassis and slot properties. It extends the ServerQualifier, offering detailed criteria for server selection within blade environments.\n#### Purpose\nBladeQualifier provides a comprehensive framework for assessing blade servers, using chassis IDs, slot IDs, and PID attributes. It ensures that blade resources align with operational requirements and optimizes server pool management.\n#### Key Concepts\n- **Chassis and Slot-Based Filtering:** Enables resource qualification based on specific physical attributes, enhancing resource allocation precision.\n- **PID Integration:** Incorporates PID criteria to improve qualification accuracy and streamline server management.\n- **Resource Optimization:** Promotes efficient blade server utilization by aligning resources with specified qualification parameters.", "x-allOf-name": "resource.BladeQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ServerQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.BladeQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.BladeQualifier" ], "default": "resource.BladeQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.BladeQualifier" ], "default": "resource.BladeQualifier", "x-enum-as-string": true }, "ChassisAndSlotIdRange": { "type": "array", "items": { "description": "The server is qualified based on the chassis ID and slot ID. For example, if the conditions are such that ChassisId is in the range of 1-4 and SlotIds are in the ranges of 1-3 and 4-6, then the server matches the ChassisId and SlotId conditions, making it eligible for the pool.", "$ref": "#/components/schemas/resource.ChassisAndSlotQualification", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "ChassisPids": { "type": "array", "items": { "description": "The chassis and Unified Edge PID based condition qualifies the server into the pool.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.ChassisAndSlotQualification": { "title": "Chassis and Slot ID Qualification", "description": "The server is qualified based on the chassis ID and slot ID. For example, if the conditions are such that ChassisId is in the range of 1-4 and SlotIds are in the ranges of 1-3 and 4-6, then the server matches the ChassisId and SlotId conditions, making it eligible for the pool.", "x-allOf-name": "resource.ChassisAndSlotQualification", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ChassisAndSlotQualification', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.ChassisAndSlotQualification" ], "default": "resource.ChassisAndSlotQualification", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.ChassisAndSlotQualification" ], "default": "resource.ChassisAndSlotQualification", "x-enum-as-string": true }, "ChassisIdRange": { "description": "The server qualification condition based on the ChassisId range.", "$ref": "#/components/schemas/resource.ChassisIdRangeFilter", "x-omitempty": true }, "SlotIdRanges": { "type": "array", "items": { "description": "The server qualification condition based on the SlotId ranges.", "$ref": "#/components/schemas/resource.SlotIdRangeFilter", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.ChassisIdRangeFilter": { "title": "Chassis ID Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum value.", "x-allOf-name": "resource.ChassisIdRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ChassisIdRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.ChassisIdRangeFilter" ], "default": "resource.ChassisIdRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.ChassisIdRangeFilter" ], "default": "resource.ChassisIdRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 40, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 40, "x-omitempty": true } } } ] }, "resource.ChassisServersQualifier": { "title": "Resource:Chassis Servers Qualifier", "description": "Resources are added to the pool based on characteristics of servers like slotId of server connected to chassis.", "x-allOf-name": "resource.ChassisServersQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ChassisServersQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.ChassisServersQualifier" ], "default": "resource.ChassisServersQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.ChassisServersQualifier" ], "default": "resource.ChassisServersQualifier", "x-enum-as-string": true }, "SlotIds": { "type": "array", "items": { "description": "Collection of slotId that server present in it.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true } } } ] }, "resource.CpuCoreRangeFilter": { "title": "CPU Core Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum CPU core value.", "x-allOf-name": "resource.CpuCoreRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.CpuCoreRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.CpuCoreRangeFilter" ], "default": "resource.CpuCoreRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.CpuCoreRangeFilter" ], "default": "resource.CpuCoreRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 9999, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 9999, "x-omitempty": true } } } ] }, "resource.CpuSpeedRangeFilter": { "title": "CPU Speed Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum CPU speed value.", "x-allOf-name": "resource.CpuSpeedRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.CpuSpeedRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.CpuSpeedRangeFilter" ], "default": "resource.CpuSpeedRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.CpuSpeedRangeFilter" ], "default": "resource.CpuSpeedRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 99, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 99, "x-omitempty": true } } } ] }, "resource.DomainQualifier": { "title": "Network Qualifier", "description": "The DomainQualifier object is designed to qualify or filter servers based on domain-specific properties. It extends the ResourceQualifier, allowing more precise targeting and selection of resources within a network infrastructure.\n#### Purpose\nThe DomainQualifier serves to refine server selection by using domain-related attributes. This provides a mechanism to match resources based on domain names and fabric interconnect product IDs (PIDs), facilitating efficient resource allocation and management.\n#### Key Concepts\n- **Domain-Based Filtering:** Allows for resource selection based on domain properties, ensuring that servers meet specific domain criteria.\n- **Fabric Interconnect PIDs:** Utilizes PID attributes to enhance qualification, supporting targeted resource management.\n- **Extensibility:** As a concrete extension of ResourceQualifier, it integrates seamlessly with other resource qualification frameworks.", "x-allOf-name": "resource.DomainQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.DomainQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.DomainQualifier" ], "default": "resource.DomainQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.DomainQualifier" ], "default": "resource.DomainQualifier", "x-enum-as-string": true }, "DomainNames": { "type": "array", "items": { "description": "The resource is qualified based on the 'Host name' property.", "type": "string", "x-omitempty": true }, "maxItems": 100, "nullable": true }, "FabricInterConnectPids": { "type": "array", "items": { "description": "The resource is qualified based on the PID property of 'Fabric Interconnects' or Unified Edge. For example, the condition PID in ('UCS-FI-6536', 'UCS-FI-7888', 'UCSXE-ECMC-G1').", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.GpuControllersRangeFilter": { "title": "GPU Controller Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum GPU controller value.", "x-allOf-name": "resource.GpuControllersRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.GpuControllersRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.GpuControllersRangeFilter" ], "default": "resource.GpuControllersRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.GpuControllersRangeFilter" ], "default": "resource.GpuControllersRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 16, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 16, "x-omitempty": true } } } ] }, "resource.GpuQualifier": { "title": "GPU Qualification.", "description": "The GpuQualifier object focuses on qualifying resources based on GPU characteristics. It extends the HardwareQualifier, providing criteria for resource selection related to GPU capabilities, including adaptors, vendor, and evaluation type.\n#### Purpose\nGpuQualifier aids in the precise filtering of resources by evaluating GPU attributes. It ensures that resources meet GPU-related requirements, optimizing resource allocation and performance within environments requiring graphical processing capabilities.\n#### Key Concepts\n- **GPU-Based Qualification:** Concentrates on GPU controller range, adaptors, and vendor attributes for resource selection.\n- **Evaluation Type Integration:** Utilizes GPU evaluation type to refine qualification processes, enhancing resource management.\n- **Extensibility:** Seamlessly integrates with other hardware qualification objects for comprehensive resource management solutions.", "x-allOf-name": "resource.GpuQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.HardwareQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.GpuQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.GpuQualifier" ], "default": "resource.GpuQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.GpuQualifier" ], "default": "resource.GpuQualifier", "x-enum-as-string": true }, "GpuControllersRange": { "description": "The qualification of resources is based on number of GPU controllers between the minimum and maximum value.", "$ref": "#/components/schemas/resource.GpuControllersRangeFilter", "x-omitempty": true }, "GpuEvaluationType": { "description": "The GPU qualifier used for resource qualification is based on gpuEvaluationType.\n* `ServerWithoutGpu` - It is used to specify the evaluation of a resource without a GPU.\n* `ServerWithGpu` - It is used to specify the evaluation of a resource with a GPU.\n* `Unspecified` - It is used to specify that the GPU qualifier should be ignored for the evaluation of a resource.", "type": "string", "enum": [ "ServerWithoutGpu", "ServerWithGpu", "Unspecified" ], "default": "ServerWithoutGpu", "x-omitempty": true }, "Pids": { "type": "array", "items": { "description": "The qualification of resources is based on PID of GPU that contains in it.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "Vendor": { "description": "The qualification of resources is based on vendor of GPU.", "type": "string", "x-omitempty": true } } } ] }, "resource.Group.Response": { "description": "The response body of a HTTP GET request for the 'resource.Group' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.Group' resources.", "x-one-of-name": "resource.Group.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.Group.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.Group.Relationship": { "description": "A relationship to the 'resource.Group' resource, or the expanded 'resource.Group' resource, or the 'null' value.", "x-one-of-name": "resource.Group.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resource.Group" } ], "discriminator": { "propertyName": "ClassId" } }, "resource.Group": { "title": "Resource:Group", "description": "The Group object represents a collection of REST resources within the system, designed to streamline resource management through organized groupings.\n#### Purpose\nA Group is intended to aggregate resources into a single entity, simplifying management tasks such as resource allocation, access control, and membership evaluation. It supports both static and dynamic resource memberships, allowing for flexible and efficient resource grouping.\n#### Key Concepts\n- **Dynamic Memberships:** Allows resources to be grouped dynamically using OData query filters, enhancing flexibility in resource management.\n- **Access Control:** Ensures only authorized users can view or perform actions on Group data.\n- **Resource Aggregation:** Supports the organization of resources into cohesive groups, aiding in resource management and allocation.", "x-allOf-name": "resource.Group", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Group', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Group" ], "default": "resource.Group", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Group" ], "default": "resource.Group", "x-enum-as-string": true }, "Description": { "description": "The informative description about the usage of this Resource Group.", "type": "string", "x-omitempty": true }, "ExportedSelectors": { "type": "array", "items": { "description": "A list of OData filters to select resources. The group selectors may include URLs of individual resources, or OData query with filters that match multiple queries. The URLs must be relative (i.e. do not include the host).", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "Name": { "description": "The name of this resource group.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,128}$", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "PerTypeCombinedSelector": { "type": "array", "items": { "description": "A single filter expression created by OR'ing the $filter criteria of the 'selectors' of a given object type. Used to efficiently maintain the membership of the group. This filter is maintained per object type in this type.", "$ref": "#/components/schemas/resource.PerTypeCombinedSelector", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Qualifier": { "description": "Qualifier shall be used to specify if we want to organize resources using multiple resource group or single For an account, resource groups can be of only one of the above types. (Both the types are mutually exclusive for an account.).\n* `Allow-Selectors` - Resources will be added to resource groups based on ODATA filter. Multiple resource group can be created to organize resources.\n* `Allow-All` - All resources will become part of the Resource Group. Only one resource group can be created to organize resources.", "type": "string", "enum": [ "Allow-Selectors", "Allow-All" ], "default": "Allow-Selectors", "x-omitempty": true }, "Reevaluate": { "description": "Set Reevaluate to true to reevaluate the group members and memberships of this resource group.", "type": "boolean", "x-omitempty": true }, "Selectors": { "type": "array", "items": { "description": "A list of OData filters to select resources. The group selectors may be include URLs of individual resources, or OData query with filters that match multiple queries. The URLs must be relative (i.e. do not include the host).", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "Type": { "description": "The type of this resource group. (Rbac, Licensing, solution).\n* `rbac` - These resource groups are used for multi-tenancy by assigning to organizations.\n* `licensing` - These resource groups are used to classify resources like servers to various groups which are associated to different license tiers.\n* `solution` - These resource groups are created for Flexpods.", "type": "string", "enum": [ "rbac", "licensing", "solution" ], "default": "rbac", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Organizations": { "description": "An array of relationships to organizationOrganization resources.", "type": "array", "items": { "$ref": "#/components/schemas/organization.Organization.Relationship" }, "nullable": true } } } ] }, "resource.Group.List": { "title": "List of 'resource.Group' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.Group' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.Group' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Group" }, "nullable": true } } } ] }, "resource.GroupMember.Response": { "description": "The response body of a HTTP GET request for the 'resource.GroupMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.GroupMember' resources.", "x-one-of-name": "resource.GroupMember.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.GroupMember.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.GroupMember": { "title": "Resource:Group Member", "description": "The GroupMember object identifies resolved members within a resource group, providing clarity and organization to resource membership management.\n#### Purpose\nA GroupMember serves as the link between individual resources and their associated groups, ensuring that resources are accurately represented within the system. It simplifies membership management by providing a clear representation of resource-group associations.\n#### Key Concepts\n- **Membership Resolution:** Ensures that resource memberships are accurately resolved and maintained within the system.\n- **Resource References:** Facilitates easy access and management of resources within groups, supporting efficient resource handling.", "x-allOf-name": "resource.GroupMember", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.GroupMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.GroupMember" ], "default": "resource.GroupMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.GroupMember" ], "default": "resource.GroupMember", "x-enum-as-string": true }, "Group": { "$ref": "#/components/schemas/resource.Group.Relationship", "description": "A reference to a resourceGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "#/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 } } } ] }, "resource.GroupMember.List": { "title": "List of 'resource.GroupMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.GroupMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.GroupMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.GroupMember" }, "nullable": true } } } ] }, "resource.HardwareQualifier": { "title": "Hardware Qualifier", "description": "The server is filtered into the pool based on specific conditions. The hardware qualifier serves as the base class for memory qualifier, processor qualifier, GPU qualifier and network adaptor qualifier which can be used for filtering resources based on hardware characteristics.", "x-allOf-name": "resource.HardwareQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" } ] }, "resource.LicenseResourceCount.Response": { "description": "The response body of a HTTP GET request for the 'resource.LicenseResourceCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.LicenseResourceCount' resources.", "x-one-of-name": "resource.LicenseResourceCount.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.LicenseResourceCount.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.LicenseResourceCount": { "title": "Resource:License Resource Count", "description": "The LicenseResourceCount object tracks the number of resources associated with different licensing tiers, aiding in licensing management and resource allocation.\n#### Purpose\nLicenseResourceCount provides a structured approach to managing licensing information within the system, ensuring that resources are accurately accounted for and associated with appropriate licensing tiers. It supports efficient resource tracking and licensing compliance.\n#### Key Concepts\n- **Licensing Management:** Facilitates the tracking and management of resources based on licensing tiers, aiding in compliance and resource allocation.\n- **Resource Tracking:** Provides accurate counts of resources within each licensing tier, supporting efficient resource management.\n- **Integration:** Seamlessly integrates with resource groups to ensure that licensing information is properly managed and utilized.", "x-allOf-name": "resource.LicenseResourceCount", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.LicenseResourceCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.LicenseResourceCount" ], "default": "resource.LicenseResourceCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.LicenseResourceCount" ], "default": "resource.LicenseResourceCount", "x-enum-as-string": true }, "LicenseType": { "description": "Type of licensing defined for this resource group. Used for licensing group.\n* `Base` - Base as a License type. It is default license type.\n* `Essential` - Essential as a License type.\n* `Standard` - Standard as a License type.\n* `Advantage` - Advantage as a License type.\n* `Premier` - Premier as a License type.\n* `IWO-Essential` - IWO-Essential as a License type.\n* `IWO-Advantage` - IWO-Advantage as a License type.\n* `IWO-Premier` - IWO-Premier as a License type.\n* `IKS-Advantage` - IKS-Advantage as a License type.\n* `INC-Premier-1GFixed` - Premier 1G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-10GFixed` - Premier 10G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-100GFixed` - Premier 100G Fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod4Slot` - Premier Modular 4 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-Mod8Slot` - Premier Modular 8 slot license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsFixed` - Premier D2Ops fixed license tier for Intersight Nexus Cloud.\n* `INC-Premier-D2OpsMod` - Premier D2Ops modular license tier for Intersight Nexus Cloud.\n* `INC-Premier-CentralizedMod8Slot` - Premier modular license tier of switch type CentralizedMod8Slot for Intersight Nexus Cloud.\n* `INC-Premier-DistributedMod8Slot` - Premier modular license tier of switch type DistributedMod8Slot for Intersight Nexus Cloud.\n* `ERP-Advantage` - Advantage license tier for ERP workflows.\n* `IntersightTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Intersight tiers.\n* `IWOTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IKS tiers.\n* `IKSTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode IWO tiers.\n* `INCTrial` - Virtual dummy license type to indicate trial. Used for UI display of trial mode Nexus tiers.", "type": "string", "enum": [ "Base", "Essential", "Standard", "Advantage", "Premier", "IWO-Essential", "IWO-Advantage", "IWO-Premier", "IKS-Advantage", "INC-Premier-1GFixed", "INC-Premier-10GFixed", "INC-Premier-100GFixed", "INC-Premier-Mod4Slot", "INC-Premier-Mod8Slot", "INC-Premier-D2OpsFixed", "INC-Premier-D2OpsMod", "INC-Premier-CentralizedMod8Slot", "INC-Premier-DistributedMod8Slot", "ERP-Advantage", "IntersightTrial", "IWOTrial", "IKSTrial", "INCTrial" ], "default": "Base", "readOnly": true, "x-omitempty": true }, "ResourceCount": { "description": "The number of resource belongs to this licensing tier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "LicenseGroups": { "description": "An array of relationships to resourceGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Group.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "resource.LicenseResourceCount.List": { "title": "List of 'resource.LicenseResourceCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.LicenseResourceCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.LicenseResourceCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.LicenseResourceCount" }, "nullable": true } } } ] }, "resource.Membership.Response": { "description": "The response body of a HTTP GET request for the 'resource.Membership' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.Membership' resources.", "x-one-of-name": "resource.Membership.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.Membership.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.Membership": { "title": "Resource:Membership", "description": "ResourceMembership represents a resource's associated groups, organizations and the permissions associated to this resource via organizations.", "x-allOf-name": "resource.Membership", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Membership', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Membership" ], "default": "resource.Membership", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Membership" ], "default": "resource.Membership", "x-enum-as-string": true }, "GroupPermissionRoles": { "type": "array", "items": { "description": "Groups, organizations and their permissions to roles mapping.", "$ref": "#/components/schemas/iam.GroupPermissionToRoles", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Reevaluate": { "description": "Set Reevaluate to true to reevaluate the membership of a resource.", "type": "boolean", "x-omitempty": true }, "TargetApp": { "description": "Name of the Service owning the resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Holder": { "$ref": "#/components/schemas/resource.MembershipHolder.Relationship", "description": "A reference to a resourceMembershipHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "#/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.", "x-createOnly": true }, "ResourceAncestors": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true } } } ] }, "resource.Membership.List": { "title": "List of 'resource.Membership' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.Membership' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.Membership' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Membership" }, "nullable": true } } } ] }, "resource.MembershipHolder.Response": { "description": "The response body of a HTTP GET request for the 'resource.MembershipHolder' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.MembershipHolder' resources.", "x-one-of-name": "resource.MembershipHolder.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.MembershipHolder.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.MembershipHolder.Relationship": { "description": "A relationship to the 'resource.MembershipHolder' resource, or the expanded 'resource.MembershipHolder' resource, or the 'null' value.", "x-one-of-name": "resource.MembershipHolder.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resource.MembershipHolder" } ], "discriminator": { "propertyName": "ClassId" } }, "resource.MembershipHolder": { "title": "Resource:Membership Holder", "description": "The MembershipHolder object acts as a container for REST resources and their membership within the system. It plays a crucial role in managing and organizing resources by associating them with specific memberships.\n#### Purpose\nA MembershipHolder serves as the central entity for resource membership management, enabling efficient organization and retrieval of resources based on their membership status. This provides a structured approach to handling resource memberships, supporting multi-tenancy and resource classification.\n#### Key Concepts\n- **Resource Organization:** Facilitates the grouping and classification of resources according to membership criteria.\n- **Access Control:** Ensures that membership data is managed securely, with access restricted to authorized users.\n- **Relationship Management:** Maintains associations between resources and their respective accounts, ensuring consistent and organized membership handling.", "x-allOf-name": "resource.MembershipHolder", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.MembershipHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.MembershipHolder" ], "default": "resource.MembershipHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.MembershipHolder" ], "default": "resource.MembershipHolder", "x-enum-as-string": true }, "Name": { "description": "The name of this resource membership holder.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "resource.MembershipHolder.List": { "title": "List of 'resource.MembershipHolder' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.MembershipHolder' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.MembershipHolder' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.MembershipHolder" }, "nullable": true } } } ] }, "resource.MemoryCapacityRangeFilter": { "title": "Memory Capacity Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum memory capacity value.", "x-allOf-name": "resource.MemoryCapacityRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.MemoryCapacityRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.MemoryCapacityRangeFilter" ], "default": "resource.MemoryCapacityRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.MemoryCapacityRangeFilter" ], "default": "resource.MemoryCapacityRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 999999, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 999999, "x-omitempty": true } } } ] }, "resource.MemoryQualifier": { "title": "Memory Qualification.", "description": "The MemoryQualifier object is dedicated to qualifying resources based on memory characteristics. It extends the HardwareQualifier, providing specialized criteria for resource selection related to memory capacity and units.\n#### Purpose\nMemoryQualifier aids in the precise filtering of resources by evaluating memory attributes. It ensures that resources meet memory-related requirements, optimizing resource allocation and performance within data center environments.\n#### Key Concepts\n- **Memory-Based Qualification:** Focuses on memory capacity and unit ranges to refine resource selection processes.\n- **Operational Efficiency:** Supports enhanced resource utilization by aligning memory parameters with operational needs.\n- **Extensibility:** Integrates seamlessly with other hardware qualification objects to provide comprehensive resource management solutions.", "x-allOf-name": "resource.MemoryQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.HardwareQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.MemoryQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.MemoryQualifier" ], "default": "resource.MemoryQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.MemoryQualifier" ], "default": "resource.MemoryQualifier", "x-enum-as-string": true }, "MemoryCapacityRange": { "description": "The qualification of resources is based on memory range between minimum and maximum value.", "$ref": "#/components/schemas/resource.MemoryCapacityRangeFilter", "x-omitempty": true }, "MemoryUnitsRange": { "description": "The qualification of resources is based on the number of memory units between minimum and maximum value.", "$ref": "#/components/schemas/resource.MemoryUnitsRangeFilter", "x-omitempty": true } } } ] }, "resource.MemoryUnitsRangeFilter": { "title": "Memory Unit Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum memory unit value.", "x-allOf-name": "resource.MemoryUnitsRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.MemoryUnitsRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.MemoryUnitsRangeFilter" ], "default": "resource.MemoryUnitsRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.MemoryUnitsRangeFilter" ], "default": "resource.MemoryUnitsRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 99999, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 99999, "x-omitempty": true } } } ] }, "resource.NetworkAdaptorQualifier": { "title": "Network Adaptor Qualification", "description": "The NetworkAdaptorQualifier object is designed to qualify resources based on network adaptor characteristics. It extends the HardwareQualifier, providing specific criteria for resource selection related to network adaptors.\n#### Purpose\nNetworkAdaptorQualifier supports the classification of resources by evaluating network adaptor attributes. It ensures that resources meet network-related requirements, optimizing resource allocation and performance in network-intensive environments.\n#### Key Concepts\n- **Adaptor-Based Qualification:** Utilizes adaptor range attributes to enhance resource filtering precision.\n- **Operational Efficiency:** Promotes effective resource utilization by aligning network adaptor characteristics with operational needs.\n- **Integration Capability:** Functions cohesively with other hardware qualification objects to streamline resource management processes.", "x-allOf-name": "resource.NetworkAdaptorQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.HardwareQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.NetworkAdaptorQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.NetworkAdaptorQualifier" ], "default": "resource.NetworkAdaptorQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.NetworkAdaptorQualifier" ], "default": "resource.NetworkAdaptorQualifier", "x-enum-as-string": true }, "AdaptorsRange": { "description": "The qualification of resources is based on number of adaptors between the minimum and maximum value.", "$ref": "#/components/schemas/resource.AdaptorsRangeFilter", "x-omitempty": true } } } ] }, "resource.OdataRuleSetQualifier": { "title": "Resource:Odata Rule Set Qualifier", "description": "Resources are added to the pool based on OData filter conditions.", "x-allOf-name": "resource.OdataRuleSetQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.RuleSetQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.OdataRuleSetQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.OdataRuleSetQualifier" ], "default": "resource.OdataRuleSetQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.OdataRuleSetQualifier" ], "default": "resource.OdataRuleSetQualifier", "x-enum-as-string": true }, "Rules": { "type": "array", "items": { "description": "A collection of OData rules used to qualify resources.", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true } } } ] }, "resource.PerTypeCombinedSelector": { "title": "Resource:Per Type Combined Selector", "description": "Complex type representing an object type to associated filter by combining all selectors.", "x-allOf-name": "resource.PerTypeCombinedSelector", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.PerTypeCombinedSelector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.PerTypeCombinedSelector" ], "default": "resource.PerTypeCombinedSelector", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.PerTypeCombinedSelector" ], "default": "resource.PerTypeCombinedSelector", "x-enum-as-string": true }, "CombinedSelector": { "description": "A single filter expression created by OR'ing the $filter criteria of the 'selectors'. Used to efficiently maintain the membership of the Group.", "type": "string", "readOnly": true, "x-omitempty": true }, "EmptyFilter": { "description": "If true, then resources are added using just object type without filter.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SelectorObjectType": { "description": "The ObjectType on which the selectors are defined. Used to efficiently query resource groups for a given ObjectType.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "resource.ProcessorQualifier": { "title": "Processor Qualification.", "description": "The ProcessorQualifier object is intended to qualify resources based on processor characteristics. It extends the HardwareQualifier, offering detailed criteria for evaluating processor speed, cores, PIDs, and vendor attributes.\n#### Purpose\nProcessorQualifier facilitates the assessment of resources according to processor specifications, ensuring that resources align with computational requirements. It enhances resource management by enabling targeted processor-based filtering.\n#### Key Concepts\n- **Processor-Based Filtering:** Utilizes speed, core count, and PID attributes to refine resource qualification.\n- **Vendor Integration:** Incorporates vendor criteria to ensure compatibility and enhance resource management.\n- **Resource Optimization:** Promotes effective resource utilization by aligning processor characteristics with operational demands.", "x-allOf-name": "resource.ProcessorQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.HardwareQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ProcessorQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.ProcessorQualifier" ], "default": "resource.ProcessorQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.ProcessorQualifier" ], "default": "resource.ProcessorQualifier", "x-enum-as-string": true }, "CpuCoresRange": { "description": "The qualification of resources is based on number of CPU cores between minimum and maximum value.", "$ref": "#/components/schemas/resource.CpuCoreRangeFilter", "x-omitempty": true }, "Pids": { "type": "array", "items": { "description": "The qualification of resources is based on the PID of the processor.", "type": "string", "x-omitempty": true }, "maxItems": 100, "nullable": true }, "SpeedRange": { "description": "The qualification of resources is based on speed of the processor between minimum and maximum value in GHz.", "$ref": "#/components/schemas/resource.CpuSpeedRangeFilter", "x-omitempty": true }, "Vendor": { "description": "The qualification of resources is based on the vendor of the processor.", "type": "string", "x-omitempty": true } } } ] }, "resource.RackIdRangeFilter": { "title": "RackId Range Over Value", "description": "The RackIdRangeFilter object is intended to define qualification criteria based on rack ID ranges. It is a concrete implementation of the RangeFilter, providing a structured approach to resource filtering in data center environments.\n#### Purpose\nRackIdRangeFilter facilitates the classification of resources within data centers by establishing boundaries for rack IDs. This enables administrators to efficiently manage and allocate resources according to specific rack configurations.\n#### Key Concepts\n- **Range-Based Qualification:** Utilizes minimum and maximum values to define rack ID limits, enabling precise resource filtering.\n- **Scalability:** Supports the inclusion of multiple rack ID ranges, enhancing flexibility in resource management.\n- **Integration:** Works in conjunction with other filtering mechanisms to streamline data center operations.", "x-allOf-name": "resource.RackIdRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.RackIdRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.RackIdRangeFilter" ], "default": "resource.RackIdRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.RackIdRangeFilter" ], "default": "resource.RackIdRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than the minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 256, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 256, "x-omitempty": true } } } ] }, "resource.RackServerQualifier": { "title": "Rack Server Qualifier", "description": "The rack servers are qualified for the pool based on properties of RackServer, such as RackId, RackPID, etc., which are captured as part of the RackServerQualifier.", "x-allOf-name": "resource.RackServerQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ServerQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.RackServerQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.RackServerQualifier" ], "default": "resource.RackServerQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.RackServerQualifier" ], "default": "resource.RackServerQualifier", "x-enum-as-string": true }, "RackIdRange": { "type": "array", "items": { "description": "The rack servers are qualified for the pool based on the rack ID range. For instance, servers that fall within the rack ID range of 1-6 will be qualified for the pool.", "$ref": "#/components/schemas/resource.RackIdRangeFilter", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.RangeFilter": { "title": "The Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum value.", "x-allOf-name": "resource.RangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.AdvancedFilter" } ] }, "resource.Reservation.Response": { "description": "The response body of a HTTP GET request for the 'resource.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 'resource.Reservation' resources.", "x-one-of-name": "resource.Reservation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.Reservation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.Reservation.Relationship": { "description": "A relationship to the 'resource.Reservation' resource, or the expanded 'resource.Reservation' resource, or the 'null' value.", "x-one-of-name": "resource.Reservation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resource.Reservation" } ], "discriminator": { "propertyName": "ClassId" } }, "resource.Reservation": { "title": "Resource:Reservation", "description": "The Reservation object is responsible for reserving slots for new resources within resource groups, ensuring organized and planned resource allocation.\n#### Purpose\nA Reservation acts as a placeholder for resources that are yet to be added to the system, providing a structured approach to resource planning and allocation. It supports seamless integration with resource groups, facilitating efficient resource management.\n#### Key Concepts\n- **Resource Allocation:** Provides a mechanism for reserving space for new resources, aiding in planned resource allocation.\n- **Integration:** Seamlessly integrates with resource groups to ensure that reserved resources are properly managed and allocated.\n- **Access Control:** Implements privilege sets to manage access to reservation data, ensuring secure and controlled resource planning.", "x-allOf-name": "resource.Reservation", "allOf": [ { "$ref": "#/components/schemas/resource.AbstractReservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.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": [ "resource.Reservation" ], "default": "resource.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": [ "resource.Reservation" ], "default": "resource.Reservation", "x-enum-as-string": true }, "MarkFail": { "description": "MarkFail is used to set the reservation status to Failed.", "type": "boolean", "x-omitempty": true }, "ResourceMoids": { "type": "array", "items": { "description": "Moids of the resources which will be added to the resource groups.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UserMoid": { "description": "Moid of the user who created the reservation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "Groups": { "description": "An array of relationships to resourceGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Group.Relationship" }, "nullable": true, "x-createOnly": true } } } ] }, "resource.Reservation.List": { "title": "List of 'resource.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.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 'resource.Reservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.Reservation" }, "nullable": true } } } ] }, "resource.ResourceQualifier": { "title": "Resource Qualifier", "description": "The resources are matched with multiple qualifiers; ResourceQualifier is the base class for all qualifiers.", "x-allOf-name": "resource.ResourceQualifier", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "resource.RuleSetQualifier": { "title": "Resource:Rule Set Qualifier", "description": "Determines whether resources qualify for inclusion in a pool based on a set of rules.", "x-allOf-name": "resource.RuleSetQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" } ] }, "resource.SelectionCriteria.Response": { "description": "The response body of a HTTP GET request for the 'resource.SelectionCriteria' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.SelectionCriteria' resources.", "x-one-of-name": "resource.SelectionCriteria.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.SelectionCriteria.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.SelectionCriteria": { "title": "Resource:Selection Criteria", "description": "The SelectionCriteria object enables the selection of resources based on specific criteria, providing flexibility and precision in resource management.\n#### Purpose\nSelectionCriteria serves as the mechanism for defining conditions that select resources within the system, offering a customizable and efficient approach to resource retrieval and management. It supports both static and dynamic resource selection methods.\n#### Key Concepts\n- **Dynamic Selection:** Allows for the use of OData query filters to dynamically select resources, enhancing flexibility in resource management.\n- **Customization:** Supports the definition of custom criteria for resource selection, providing tailored resource management solutions.\n- **Access Control:** Implements privilege sets to manage access to selection criteria data, ensuring secure and controlled resource selection.", "x-allOf-name": "resource.SelectionCriteria", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SelectionCriteria', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SelectionCriteria" ], "default": "resource.SelectionCriteria", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SelectionCriteria" ], "default": "resource.SelectionCriteria", "x-enum-as-string": true }, "Description": { "description": "The description of the Resource Selection Criteria.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "Name of the Resource Selection Criteria.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,128}$", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "PlaceHolders": { "type": "array", "items": { "description": "The selector query can contain zero or more runtime parameters. The placeholders contains a collection of runtime parameters which are extracted from selector query.\nFor example, the OData filter condition for resource VmwareHost is \"MemoryConsumed gt {{.ResourceMemoryConsumed}} and ResourceConsumed.CpuConsumed gt {{.ResourceCpuConsumed}}\" is having ResourceMemoryConsumed and ResourceCpuConsumed are runtime properties which will be extracted as part of this collection.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Selectors": { "type": "array", "items": { "description": "The selectors may be include URLs of individual resources, or OData query with filters that match multiple resources. The URLs must be relative (i.e. do not include the host).\nThe resource selector can have runtime parameters through which value will be supplied by the consumer API. For example, the SelectionCriteria is to select the compute.RackUnit based CpuCore' and 'Available'.\nFor example, the OData filter condition for resource VmwareHost is \"ResourceConsumed.MemoryConsumed gt {{.ResourceMemoryConsumed}} and ResourceConsumed.CpuConsumed gt {{.ResourceCpuConsumed}}\"\nIn the above example, \"ResourceMemoryConsumed\" and \"ResourceCpuConsumed\" are placeholder properties.", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "#/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 } } } ] }, "resource.SelectionCriteria.List": { "title": "List of 'resource.SelectionCriteria' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.SelectionCriteria' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.SelectionCriteria' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.SelectionCriteria" }, "nullable": true } } } ] }, "resource.Selector": { "title": "Resource:Selector", "description": "Complex type representing the filter condition to extract the resources.", "x-allOf-name": "resource.Selector", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Selector', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Selector" ], "default": "resource.Selector", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Selector" ], "default": "resource.Selector", "x-enum-as-string": true }, "Selector": { "description": "ODATA filter to select resources. The group selector may include URLs of individual resource, or OData query with filters that match multiple queries. The URLs must be relative (i.e. do not include the host).", "type": "string", "pattern": "^$|/api/v1/.*", "x-createOnly": true, "x-omitempty": true } } } ] }, "resource.ServerQualifier": { "title": "Server Qualifier", "description": "The server is filtered into the pool based on specific conditions. The server qualifier serves as the base class for RackServer and BladeQualifier, holding common properties, such as 'AssetTag', 'UserLabel' etc., which can be used for filtering.", "x-allOf-name": "resource.ServerQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.ServerQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "resource.BladeQualifier", "resource.RackServerQualifier" ], "x-enum-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": [ "resource.BladeQualifier", "resource.RackServerQualifier" ], "x-enum-as-string": true }, "AssetTags": { "type": "array", "items": { "description": "The qualification is based on the 'AssetTag' property. For instance, the condition is AssetTag in 'ProdServer', 'StageServer'.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "Pids": { "type": "array", "items": { "description": "The Rack or Node Servers are qualified for the pool based on PIDs. For example, the conditions include PID in 'UCSB-B200-M5', 'UCSB-B200-M6'.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "UserLabels": { "type": "array", "items": { "description": "The qualification is based on the 'UserLabel' property. For instance, the condition is UserLabel in 'ProdServer', 'StageServer'.", "type": "string", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resource.SharedResourcesInfoHolder.Response": { "description": "The response body of a HTTP GET request for the 'resource.SharedResourcesInfoHolder' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resource.SharedResourcesInfoHolder' resources.", "x-one-of-name": "resource.SharedResourcesInfoHolder.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resource.SharedResourcesInfoHolder.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resource.SharedResourcesInfoHolder": { "title": "Resource:Shared Resources Info Holder", "description": "The SharedResourcesInfoHolder object manages holds shared resource configurations within the system, facilitating resource sharing and collaboration.\n#### Purpose\nSharedResourcesInfoHolder acts as the central entity for managing holding shared resources, this object provides a centralized view of all shared resource configurations between two organizations. It supports efficient resource management and organizational integration.\n#### Key Concepts\n- **Resource Sharing:** Facilitates the sharing of resources between different organizational units, aiding in collaboration and integration.\n- **Configuration Management:** Manages shared resource configurations, ensuring consistent and organized resource sharing.\n- **Access Control:** Integrates access restrictions to ensure secure and controlled management of shared resources.", "x-allOf-name": "resource.SharedResourcesInfoHolder", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SharedResourcesInfoHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SharedResourcesInfoHolder" ], "default": "resource.SharedResourcesInfoHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SharedResourcesInfoHolder" ], "default": "resource.SharedResourcesInfoHolder", "x-enum-as-string": true }, "Account": { "$ref": "#/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 }, "PeerObjects": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "SharedResource": { "$ref": "#/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 }, "SharedWithResource": { "$ref": "#/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 }, "SharingRule": { "$ref": "#/components/schemas/iam.SharingRule.Relationship", "description": "A reference to a iamSharingRule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SourceObject": { "$ref": "#/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 } } } ] }, "resource.SharedResourcesInfoHolder.List": { "title": "List of 'resource.SharedResourcesInfoHolder' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resource.SharedResourcesInfoHolder' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resource.SharedResourcesInfoHolder' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resource.SharedResourcesInfoHolder" }, "nullable": true } } } ] }, "resource.SlotIdRangeFilter": { "title": "Slot ID Range Over Value", "description": "Consist of two boundaries that define the range, namely the minimum and the maximum SlotId value.", "x-allOf-name": "resource.SlotIdRangeFilter", "allOf": [ { "$ref": "#/components/schemas/resource.RangeFilter" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SlotIdRangeFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SlotIdRangeFilter" ], "default": "resource.SlotIdRangeFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SlotIdRangeFilter" ], "default": "resource.SlotIdRangeFilter", "x-enum-as-string": true }, "MaxValue": { "description": "Maximum value for the range limit. It should be greater than minimum value.", "type": "integer", "format": "int64", "default": 0, "maximum": 8, "x-omitempty": true }, "MinValue": { "description": "Minimum value for the range limit.", "type": "integer", "format": "int64", "default": 0, "maximum": 8, "x-omitempty": true } } } ] }, "resource.SourceToPermissionResources": { "title": "Resource:Source To Permission Resources", "description": "SourceToPermissionResources holds the source and the permissionResources belonging to them.", "x-allOf-name": "resource.SourceToPermissionResources", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SourceToPermissionResources', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SourceToPermissionResources" ], "default": "resource.SourceToPermissionResources", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SourceToPermissionResources" ], "default": "resource.SourceToPermissionResources", "x-enum-as-string": true }, "PermissionResources": { "type": "array", "items": { "description": "It holds the references of the permissionResources which belongs to the source object.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PropagateToTarget": { "description": "PropagateToTarget is a boolean value which indicates whether to propagate the PermissionResources of the \nsource object to the PermissionResources of the target object. If set to true, then PermissionResources of\nthe target object along with its children hierarchy gets updated with PermissionResources of the source \nobject. If set to false while propagating the PermissionResources from source object, PermissionResources \nagainst the Source in SourceToPermissionResourceHolder property of Target object will be set to \nPermissionResources of the source object. In this case, while evaluating access to an MO, we need to consider \nCustomPermissionResources for org user to get right access to the MO.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "SourceObject": { "description": "It holds the reference of the source object from which the permission \nis inherited.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true } } } ] }, "resource.SourceToPermissionResourcesHolder": { "title": "Resource:Source To Permission Resources Holder", "description": "The holder which holds the multiple custom permission sources and the permissionResources belonging to the sources.\nThese permissionResources are added to the permission resources of the objects which supports permission inherition\nfrom custom sources.", "x-allOf-name": "resource.SourceToPermissionResourcesHolder", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.SourceToPermissionResourcesHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.SourceToPermissionResourcesHolder" ], "default": "resource.SourceToPermissionResourcesHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.SourceToPermissionResourcesHolder" ], "default": "resource.SourceToPermissionResourcesHolder", "x-enum-as-string": true }, "SourceToPermissionResources": { "type": "array", "items": { "description": "The collection of the sources and the permissionResources belonging to them.", "$ref": "#/components/schemas/resource.SourceToPermissionResources", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "resource.Tag": { "title": "Tag key and value to filter the resource.", "description": "The Tag object represents a key-value pair used for resource filtering based on user-defined criteria. It functions as a concrete element within the qualification framework, supporting diverse tagging strategies.\n#### Purpose\nTag serves as a versatile tool for resource categorization and management. By enabling the application of custom tags, it facilitates dynamic resource filtering and enhances operational efficiency in complex environments.\n#### Key Concepts\n- **User-Defined Tagging:** Supports the creation of personalized tags to meet specific organizational needs.\n- **Flexible Filtering:** Allows for adaptable resource qualification, accommodating diverse operational scenarios.\n- **Integration Capability:** Works cohesively with other qualification objects to streamline resource management processes.", "x-allOf-name": "resource.Tag", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.Tag', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.Tag" ], "default": "resource.Tag", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.Tag" ], "default": "resource.Tag", "x-enum-as-string": true }, "Key": { "description": "Key to match the resource's tag key.", "type": "string", "minLength": 1, "maxLength": 128, "x-omitempty": true }, "Value": { "description": "Value to match the resource's tag value.", "type": "string", "minLength": 1, "maxLength": 256, "x-omitempty": true } } } ] }, "resource.TagQualifier": { "title": "Tag Qualification.", "description": "The resource is qualified based on user tags at various types, such as Domain, Chassis, Blade, Rack, etc. The filtering of resources is determined by matching these tags with set conditions.", "x-allOf-name": "resource.TagQualifier", "allOf": [ { "$ref": "#/components/schemas/resource.ResourceQualifier" }, { "type": "object", "description": "Definition of the list of properties defined in 'resource.TagQualifier', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resource.TagQualifier" ], "default": "resource.TagQualifier", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resource.TagQualifier" ], "default": "resource.TagQualifier", "x-enum-as-string": true }, "ChassisTags": { "type": "array", "items": { "description": "The qualification of resources is based on the user tags defined at the chassis and unified edge level for the resource.", "$ref": "#/components/schemas/resource.Tag", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "DomainProfileTags": { "type": "array", "items": { "description": "The qualification of resources is based on the user tags defined at the domain and unified edge profile level for the resource.", "$ref": "#/components/schemas/resource.Tag", "x-omitempty": true }, "maxItems": 20, "nullable": true }, "ServerTags": { "type": "array", "items": { "description": "The qualification of resources is based on the user tags defined at the rack or blade server level for the resource.", "$ref": "#/components/schemas/resource.Tag", "x-omitempty": true }, "maxItems": 20, "nullable": true } } } ] }, "resourcepool.ChassisQualificationPolicy.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.ChassisQualificationPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resourcepool.ChassisQualificationPolicy' resources.", "x-one-of-name": "resourcepool.ChassisQualificationPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.ChassisQualificationPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.ChassisQualificationPolicy": { "title": "Resourcepool:Chassis Qualification Policy", "description": "The ChassisQualificationPolicy maintains the qualifiers, and each qualifier manages a set of conditions to qualify the chassis and servers that connected to it. The ChassisQualificationPolicy can be attached to the pool to extract the resources that match the qualifiers specified in the policy.", "x-allOf-name": "resourcepool.ChassisQualificationPolicy", "allOf": [ { "$ref": "#/components/schemas/resource.AbstractResourceQualificationPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.ChassisQualificationPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.ChassisQualificationPolicy" ], "default": "resourcepool.ChassisQualificationPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.ChassisQualificationPolicy" ], "default": "resourcepool.ChassisQualificationPolicy", "x-enum-as-string": true }, "ExcludeServers": { "description": "When set to true, qualify the chassis alone into pool. When set to false, qualify the servers like Rack server and Blade along with chassis.", "type": "boolean", "default": false, "x-omitempty": true }, "Organization": { "$ref": "#/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 }, "ResourcePools": { "description": "An array of relationships to resourcepoolPool resources.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.Pool.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "resourcepool.ChassisQualificationPolicy.List": { "title": "List of 'resourcepool.ChassisQualificationPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.ChassisQualificationPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resourcepool.ChassisQualificationPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.ChassisQualificationPolicy" }, "nullable": true } } } ] }, "resourcepool.ChildLeaseCondition": { "title": "ChildLeaseCondition", "description": "Condition to determine the eligibility of the resource for leasing. The condition includes one or\nmore qualifiers that define the resource's qualification for leasing.", "x-allOf-name": "resourcepool.ChildLeaseCondition", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.ChildLeaseCondition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.ChildLeaseCondition" ], "default": "resourcepool.ChildLeaseCondition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.ChildLeaseCondition" ], "default": "resourcepool.ChildLeaseCondition", "x-enum-as-string": true }, "AssignedToEntity": { "description": "Mo of the entity/server profile that owns this resource.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Condition": { "type": "array", "items": { "description": "Set of qualifiers to qualify the resource for lease.", "$ref": "#/components/schemas/resource.ResourceQualifier", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Feature": { "description": "Lease operation applied for the feature.", "type": "string", "readOnly": true, "x-omitempty": true }, "Lease": { "description": "Reference to child lease, it maintain the lease details to it's child resource.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true } } } ] }, "resourcepool.Lease.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.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 'resourcepool.Lease' resources.", "x-one-of-name": "resourcepool.Lease.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.Lease.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.Lease.Relationship": { "description": "A relationship to the 'resourcepool.Lease' resource, or the expanded 'resourcepool.Lease' resource, or the 'null' value.", "x-one-of-name": "resourcepool.Lease.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resourcepool.Lease" } ], "discriminator": { "propertyName": "ClassId" } }, "resourcepool.Lease": { "title": "Resourcepool:Lease", "description": "Lease API invoked by passing resource pool, lease API will reserve or un-reserve the resource from the pool.", "x-allOf-name": "resourcepool.Lease", "allOf": [ { "$ref": "#/components/schemas/pool.AbstractLease" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.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": [ "resourcepool.Lease" ], "default": "resourcepool.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": [ "resourcepool.Lease" ], "default": "resourcepool.Lease", "x-enum-as-string": true }, "ChildLeaseCondition": { "type": "array", "items": { "description": "Set of conditions to qualify for additional resources in a group lease. Each condition contains one or more qualifiers that define the resource qualification for leasing.", "$ref": "#/components/schemas/resourcepool.ChildLeaseCondition", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "Condition": { "type": "array", "items": { "description": "A list of ODATA filters to select resources. The group selectors may be include URLs of individual resources, or OData query with filters that match multiple queries. The URLs must be relative (i.e. do not include the host).", "$ref": "#/components/schemas/resource.Selector", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "Feature": { "description": "Lease opertion applied for the feature.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "IsExclusiveAtAssignedEntity": { "description": "Indicates whether a lease allocation is exclusive based on the Assigned Entity, if the AssignedEntity holds any lease then not allowed to create new lease later.", "type": "boolean", "default": false, "x-createOnly": true, "x-omitempty": true }, "LeaseParameters": { "description": "The lease specific parameters.", "$ref": "#/components/schemas/resourcepool.LeaseParameters", "x-createOnly": true, "x-omitempty": true }, "Resource": { "description": "Reference to resource, it maintain the resource detail for static based lease.", "$ref": "#/components/schemas/mo.BaseMo", "x-createOnly": true, "x-omitempty": true }, "ResourceType": { "description": "The type of resource present in the pool, such as 'server' can be a RackUnit or Blade.\n* `Server` - Resource Pool holds the server kind of resources, example - RackServer, Blade.\n* `Mixed` - Resource Pool holds the resources like Rack Server, Blade or Chassis.\n* `None` - The resource cannot consider for Resource Pool.", "type": "string", "enum": [ "Server", "Mixed", "None" ], "default": "Server", "x-createOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "#/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." }, "LeasedResource": { "$ref": "#/components/schemas/resourcepool.LeaseResource.Relationship", "description": "A reference to a resourcepoolLeaseResource resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Pool": { "$ref": "#/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.", "x-createOnly": true }, "PoolMember": { "$ref": "#/components/schemas/resourcepool.PoolMember.Relationship", "description": "A reference to a resourcepoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/resourcepool.Universe.Relationship", "description": "A reference to a resourcepoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "resourcepool.Lease.List": { "title": "List of 'resourcepool.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.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 'resourcepool.Lease' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.Lease" }, "nullable": true } } } ] }, "resourcepool.LeaseParameters": { "title": "Resourcepool:Lease Parameters", "description": "The lease operations has some special operations based on the PoolType and ResourceType. Those special operations are handled based on this parameter.", "x-allOf-name": "resourcepool.LeaseParameters", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "resourcepool.LeaseResource.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.LeaseResource' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resourcepool.LeaseResource' resources.", "x-one-of-name": "resourcepool.LeaseResource.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.LeaseResource.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.LeaseResource.Relationship": { "description": "A relationship to the 'resourcepool.LeaseResource' resource, or the expanded 'resourcepool.LeaseResource' resource, or the 'null' value.", "x-one-of-name": "resourcepool.LeaseResource.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resourcepool.LeaseResource" } ], "discriminator": { "propertyName": "ClassId" } }, "resourcepool.LeaseResource": { "title": "Resourcepool:Lease Resource", "description": "Lease API is for reserve or unreserve the resource from the pool. Those reserved resource details are maintained in LeaseResource.", "x-allOf-name": "resourcepool.LeaseResource", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.LeaseResource', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.LeaseResource" ], "default": "resourcepool.LeaseResource", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.LeaseResource" ], "default": "resourcepool.LeaseResource", "x-enum-as-string": true }, "Feature": { "description": "Lease opertion applied for the feature.", "type": "string", "readOnly": true, "x-omitempty": true }, "Resource": { "$ref": "#/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 } } } ] }, "resourcepool.LeaseResource.List": { "title": "List of 'resourcepool.LeaseResource' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.LeaseResource' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resourcepool.LeaseResource' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.LeaseResource" }, "nullable": true } } } ] }, "resourcepool.MembershipReservation.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.MembershipReservation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resourcepool.MembershipReservation' resources.", "x-one-of-name": "resourcepool.MembershipReservation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.MembershipReservation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.MembershipReservation": { "title": "Resourcepool:Membership Reservation", "description": "A MembershipReservation is created when a resource that belongs to a pool is decommissioned. The MembershipReservation is mapped to pools that have the resource chosen for decommissioning. This MembershipReservation will be utilized in the future to pre-provision servers based on membership serials.\nThe system automatically generates the membership during decommissioning, and its permissions are updated for all organizations associated with the pools. Users of the pool have the authority to remove the pool from the membership. The membership will be removed either during recommissioning or when all the associated pools are deleted.", "x-allOf-name": "resourcepool.MembershipReservation", "allOf": [ { "$ref": "#/components/schemas/resource.AbstractReservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.MembershipReservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.MembershipReservation" ], "default": "resourcepool.MembershipReservation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.MembershipReservation" ], "default": "resourcepool.MembershipReservation", "x-enum-as-string": true }, "Account": { "$ref": "#/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.", "x-createOnly": true }, "Pools": { "description": "An array of relationships to resourcepoolPool resources.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.Pool.Relationship" }, "nullable": true } } } ] }, "resourcepool.MembershipReservation.List": { "title": "List of 'resourcepool.MembershipReservation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.MembershipReservation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resourcepool.MembershipReservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.MembershipReservation" }, "nullable": true } } } ] }, "resourcepool.Pool.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.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 'resourcepool.Pool' resources.", "x-one-of-name": "resourcepool.Pool.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.Pool.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.Pool.Relationship": { "description": "A relationship to the 'resourcepool.Pool' resource, or the expanded 'resourcepool.Pool' resource, or the 'null' value.", "x-one-of-name": "resourcepool.Pool.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resourcepool.Pool" } ], "discriminator": { "propertyName": "ClassId" } }, "resourcepool.Pool": { "title": "Resourcepool:Pool", "description": "Pool represents a collection of resource. The resource can be any MO which has PoolResource meta enabled. The resource in the pool can be reserved or unreserved by using Lease API, reserved/unreserved resources can be used in the entities like server profiles.", "x-allOf-name": "resourcepool.Pool", "allOf": [ { "$ref": "#/components/schemas/pool.AbstractPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.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": [ "resourcepool.Pool" ], "default": "resourcepool.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": [ "resourcepool.Pool" ], "default": "resourcepool.Pool", "x-enum-as-string": true }, "Action": { "description": "The pool is evaluated for resources with associated policies based on action. This action will help users to re-sync the resources for a pool.\n* `None` - The pool will not be considered for evaluation.\n* `ReEvaluate` - The resources in the pool will be re-evaluated against the server pool qualification associated with it.", "type": "string", "enum": [ "None", "ReEvaluate" ], "default": "None", "x-omitempty": true }, "ExportedSelectors": { "type": "array", "items": { "description": "Selectors that are exported during a backup operation and then applied during post restore actions.", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "PoolType": { "description": "The resource management type in the pool, it can be either static or dynamic.\n* `Static` - The resources in the pool will not be changed until user manually update it.\n* `Dynamic` - The resources in the pool will be updated dynamically based on the condition.\n* `Hybrid` - The resources in the pool can be added by the user statically or dynamically, based on the matching conditions of the qualification policy. If the pool contains both statically added resources and resources added based on the qualification policy, the pool type can be classified as hybrid.", "type": "string", "enum": [ "Static", "Dynamic", "Hybrid" ], "default": "Static", "x-omitempty": true }, "ResourceEvaluationStatus": { "description": "The resources are added to the pool based on conditions specified by the qualifiers. If there are any changes in the qualifier conditions or the properties of the resources, the corresponding pool will be evaluated for those changes. Subsequently, resources will be updated in the pool based on matching criteria. The status of these changes is tracked using ResourceEvaluationStatus.", "$ref": "#/components/schemas/resourcepool.ResourceEvaluationStatus", "readOnly": true, "x-omitempty": true }, "ResourcePoolParameters": { "description": "The pool specific parameters.", "$ref": "#/components/schemas/resourcepool.ResourcePoolParameters", "x-omitempty": true }, "ResourceType": { "description": "The type of the resource present in the pool, example 'server' its combination of RackUnit and Blade.\n* `Server` - Resource Pool holds the server kind of resources, example - RackServer, Blade.\n* `Mixed` - Resource Pool holds the resources like Rack Server, Blade or Chassis.\n* `None` - The resource cannot consider for Resource Pool.", "type": "string", "enum": [ "Server", "Mixed", "None" ], "default": "Server", "x-omitempty": true }, "Selectors": { "type": "array", "items": { "description": "A list of ODATA filters to select resources. Group selectors may include URLs for individual resources or OData queries with filters that match multiple queries. Ensure that the URLs are relative, excluding the host. For the server use case, the filter condition can specify the Serial, Moid, and ManagementMode filter properties.", "$ref": "#/components/schemas/resource.Selector", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "#/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 }, "QualificationPolicies": { "description": "An array of relationships to resourceAbstractResourceQualificationPolicy resources.", "type": "array", "items": { "$ref": "#/components/schemas/resource.AbstractResourceQualificationPolicy.Relationship" }, "nullable": true }, "Reservations": { "description": "An array of relationships to resourcepoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.Reservation.Relationship" }, "nullable": true } } } ] }, "resourcepool.Pool.List": { "title": "List of 'resourcepool.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.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 'resourcepool.Pool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.Pool" }, "nullable": true } } } ] }, "resourcepool.PoolMember.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.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 'resourcepool.PoolMember' resources.", "x-one-of-name": "resourcepool.PoolMember.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.PoolMember.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.PoolMember.Relationship": { "description": "A relationship to the 'resourcepool.PoolMember' resource, or the expanded 'resourcepool.PoolMember' resource, or the 'null' value.", "x-one-of-name": "resourcepool.PoolMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resourcepool.PoolMember" } ], "discriminator": { "propertyName": "ClassId" } }, "resourcepool.PoolMember": { "title": "Resourcepool:Pool Member", "description": "PoolMember represents a resources that is part of a pool.", "x-allOf-name": "resourcepool.PoolMember", "allOf": [ { "$ref": "#/components/schemas/pool.AbstractPoolMember" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.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": [ "resourcepool.PoolMember" ], "default": "resourcepool.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": [ "resourcepool.PoolMember" ], "default": "resourcepool.PoolMember", "x-enum-as-string": true }, "Features": { "type": "array", "items": { "description": "Feature use cases in which resource allocated.", "type": "string", "x-omitempty": true }, "nullable": true }, "QualificationType": { "description": "The resource is added statically or dynamically. If the resource is added dynamically, it includes information about the qualification policy under which the resource is added.", "$ref": "#/components/schemas/resourcepool.QualificationType", "readOnly": true, "x-omitempty": true }, "Reserved": { "description": "Identifies if the member has been reserved.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "AssignedToEntity": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "Peer": { "$ref": "#/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 }, "Pool": { "$ref": "#/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.", "readOnly": true }, "Reservation": { "$ref": "#/components/schemas/resourcepool.Reservation.Relationship", "description": "A reference to a resourcepoolReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Resource": { "$ref": "#/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 } } } ] }, "resourcepool.PoolMember.List": { "title": "List of 'resourcepool.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.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 'resourcepool.PoolMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.PoolMember" }, "nullable": true } } } ] }, "resourcepool.QualificationPolicy.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.QualificationPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'resourcepool.QualificationPolicy' resources.", "x-one-of-name": "resourcepool.QualificationPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.QualificationPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.QualificationPolicy": { "title": "Resourcepool:Qualification Policy", "description": "The QualificationPolicy object is pivotal in managing conditions that qualify server resources within a pool. It is attached to pools to dynamically extract resources based on specified qualifiers.\n#### Purpose\nThe QualificationPolicy object enables resource pools to maintain a set of conditions that qualify server resources. It ensures that resources match the qualifiers specified in the policy, allowing pools to dynamically manage their contents according to predefined criteria.\n#### Key Concepts\n- **Dynamic Resource Allocation:** Allows the pool to adapt its contents dynamically based on changing resource conditions and criteria.\n- **Integration with Resource Pools:** Directly influences the composition of resource pools by applying qualification rules and policies.\n- **Access Control:** Provides a structured approach to resource qualification, ensuring only authorized users can modify policies.", "x-allOf-name": "resourcepool.QualificationPolicy", "allOf": [ { "$ref": "#/components/schemas/resource.AbstractResourceQualificationPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.QualificationPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.QualificationPolicy" ], "default": "resourcepool.QualificationPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.QualificationPolicy" ], "default": "resourcepool.QualificationPolicy", "x-enum-as-string": true }, "Organization": { "$ref": "#/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 }, "ResourcePools": { "description": "An array of relationships to resourcepoolPool resources.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.Pool.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "resourcepool.QualificationPolicy.List": { "title": "List of 'resourcepool.QualificationPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.QualificationPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'resourcepool.QualificationPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.QualificationPolicy" }, "nullable": true } } } ] }, "resourcepool.QualificationType": { "title": "Qualification Type", "description": "The QualificationType denotes the method by which a resource is added to a pool. It serves as an\nidentifier to distinguish between static and dynamic resource additions. 'Static' indicates that the\nresource is added with predetermined specifications. Conversely, 'Dynamic' suggests that the resource\nis added based on specific conditions or qualifiers. In the dynamic case, this includes the qualification\npolicies under which the resource is discovered.", "x-allOf-name": "resourcepool.QualificationType", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.QualificationType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.QualificationType" ], "default": "resourcepool.QualificationType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.QualificationType" ], "default": "resourcepool.QualificationType", "x-enum-as-string": true }, "IsStaticAddition": { "description": "The resource is added statically or dynamically. If the value is true, it signifies a static addition, implying that the resource was added with fixed specifications. Conversely, if the value is false, it suggests a dynamic addition, indicating that the resource was incorporated based on certain conditions or qualifiers.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "QualificationPolicies": { "type": "array", "items": { "description": "The qualification policies under which the resource was discovered.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "resourcepool.Reservation.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.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 'resourcepool.Reservation' resources.", "x-one-of-name": "resourcepool.Reservation.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.Reservation.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.Reservation.Relationship": { "description": "A relationship to the 'resourcepool.Reservation' resource, or the expanded 'resourcepool.Reservation' resource, or the 'null' value.", "x-one-of-name": "resourcepool.Reservation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resourcepool.Reservation" } ], "discriminator": { "propertyName": "ClassId" } }, "resourcepool.Reservation": { "title": "Resourcepool:Reservation", "description": "The resource reservation object, used to hold reserved resources for a pool. It captures the reservation identity (for example, a serial), allocation type, and the pool reference so the reservation survives pool membership changes and can be reconciled during import/restore.", "x-allOf-name": "resourcepool.Reservation", "allOf": [ { "$ref": "#/components/schemas/pool.Reservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.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": [ "resourcepool.Reservation" ], "default": "resourcepool.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": [ "resourcepool.Reservation" ], "default": "resourcepool.Reservation", "x-enum-as-string": true }, "Identity": { "description": "The type and serial number of the resource for display.", "type": "string", "readOnly": true, "x-omitempty": true }, "ResourceSerial": { "description": "The serial number of the resource.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ResourceType": { "description": "The MO type of the resource being reserved.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/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/resourcepool.Pool.Relationship", "description": "A reference to a resourcepoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PoolMember": { "$ref": "#/components/schemas/resourcepool.PoolMember.Relationship", "description": "A reference to a resourcepoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/resourcepool.Universe.Relationship", "description": "A reference to a resourcepoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "resourcepool.Reservation.List": { "title": "List of 'resourcepool.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.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 'resourcepool.Reservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.Reservation" }, "nullable": true } } } ] }, "resourcepool.ReservationReference": { "title": "Resourcepool:Reservation Reference", "description": "The reference to the reservation object.", "x-allOf-name": "resourcepool.ReservationReference", "allOf": [ { "$ref": "#/components/schemas/pool.ReservationReference" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.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": [ "resourcepool.ReservationReference" ], "default": "resourcepool.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": [ "resourcepool.ReservationReference" ], "default": "resourcepool.ReservationReference", "x-enum-as-string": true }, "PoolMoid": { "description": "The moid of the pool object, if applicable.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ResourceSerial": { "description": "The serial number of the resource that is being reserved.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ResourceType": { "description": "The resource type that is being reserved.", "type": "string", "x-createOnly": true, "x-omitempty": true } } } ] }, "resourcepool.ResourceEvaluationStatus": { "title": "Resource Evaluation Status", "description": "The resources are added to the pool based on conditions specified by the qualifiers. If there are any\nchanges in the qualifier conditions or the properties of the resources, the corresponding pool will be\nevaluated for those changes. Subsequently, resources will be updated in the pool based on matching\ncriteria. The status of these changes is tracked using ResourceEvaluationStatus.", "x-allOf-name": "resourcepool.ResourceEvaluationStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.ResourceEvaluationStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.ResourceEvaluationStatus" ], "default": "resourcepool.ResourceEvaluationStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.ResourceEvaluationStatus" ], "default": "resourcepool.ResourceEvaluationStatus", "x-enum-as-string": true }, "ErrMsg": { "description": "The reason for the failure in ResourceEvaluation.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "The state of the evaluation operation.\n* `ok` - The policy association or validation is successful.\n* `error` - The policy association or validation has failed.\n* `validating` - The policy association or validation is in progress.", "type": "string", "enum": [ "ok", "error", "validating" ], "default": "ok", "readOnly": true, "x-omitempty": true } } } ] }, "resourcepool.ResourcePoolParameters": { "title": "Resourcepool:Resource Pool Parameters", "description": "The resource pool can hold different type of resources, each resources can have some specific parameters and functionality, those details are captured as part of this.", "x-allOf-name": "resourcepool.ResourcePoolParameters", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "resourcepool.ServerLeaseParameters": { "title": "Server Lease Parameters", "description": "This lease specific parameters are captured as part this parameter.", "x-allOf-name": "resourcepool.ServerLeaseParameters", "allOf": [ { "$ref": "#/components/schemas/resourcepool.LeaseParameters" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.ServerLeaseParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.ServerLeaseParameters" ], "default": "resourcepool.ServerLeaseParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.ServerLeaseParameters" ], "default": "resourcepool.ServerLeaseParameters", "x-enum-as-string": true }, "LifeCycleStates": { "type": "array", "items": { "description": "The resource can be considered for lease which is part of these LifeCycleStates.\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", "x-omitempty": true }, "nullable": true } } } ] }, "resourcepool.ServerPoolParameters": { "title": "Server Parameters", "description": "This server pool specific parameters are captured as part this parameter.", "x-allOf-name": "resourcepool.ServerPoolParameters", "allOf": [ { "$ref": "#/components/schemas/resourcepool.ResourcePoolParameters" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.ServerPoolParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "resourcepool.ServerPoolParameters" ], "default": "resourcepool.ServerPoolParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "resourcepool.ServerPoolParameters" ], "default": "resourcepool.ServerPoolParameters", "x-enum-as-string": true }, "ManagementMode": { "description": "The platform for which the servers in resource pool are 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* `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 }, "TargetPlatform": { "description": "The platform for which the servers in resource pool are applicable. It can either be a server that is operating in standalone mode or or one that is attached to a Fabric Interconnect or Unified Edge Chassis managed by Intersight.\n* `None` - Server which are not belongs to any platform.\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": [ "None", "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "None", "x-omitempty": true } } } ] }, "resourcepool.Universe.Response": { "description": "The response body of a HTTP GET request for the 'resourcepool.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 'resourcepool.Universe' resources.", "x-one-of-name": "resourcepool.Universe.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/resourcepool.Universe.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "resourcepool.Universe.Relationship": { "description": "A relationship to the 'resourcepool.Universe' resource, or the expanded 'resourcepool.Universe' resource, or the 'null' value.", "x-one-of-name": "resourcepool.Universe.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/resourcepool.Universe" } ], "discriminator": { "propertyName": "ClassId" } }, "resourcepool.Universe": { "title": "Resourcepool:Universe", "description": "Universe represents a book keeping container to keep track of all Resources for a given Account.", "x-allOf-name": "resourcepool.Universe", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'resourcepool.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": [ "resourcepool.Universe" ], "default": "resourcepool.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": [ "resourcepool.Universe" ], "default": "resourcepool.Universe", "x-enum-as-string": true }, "Account": { "$ref": "#/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 } } } ] }, "resourcepool.Universe.List": { "title": "List of 'resourcepool.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'resourcepool.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 'resourcepool.Universe' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/resourcepool.Universe" }, "nullable": true } } } ] }, "rproxy.ReverseProxy": { "title": "Rproxy:Reverse Proxy", "description": "The ReverseProxy object serves as a pivotal element within the network infrastructure, enabling the implementation of REST API endpoints for reverse proxy operations. It is responsible for processing API requests and directing them to Terraform Cloud based on the credentials in Terrform Cloud target.\n#### Purpose\nThe ReverseProxy object is designed to efficiently manage and forward API requests. It acts as an intermediary, fetching necessary credentials from targets and ensuring seamless redirection to Terraform Cloud.\n#### Key Concepts\n- **Credential Management:** Ensures the retrieval of appropriate credentials before request forwarding.\n- **Target-Based Routing:** Determines the routing of requests based on specified target types.", "x-allOf-name": "rproxy.ReverseProxy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'rproxy.ReverseProxy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "rproxy.ReverseProxy" ], "default": "rproxy.ReverseProxy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "rproxy.ReverseProxy" ], "default": "rproxy.ReverseProxy", "x-enum-as-string": true }, "Account": { "$ref": "#/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." } } } ] }, "scheduler.AbstractSchedulingParams": { "title": "Scheduler:Abstract Scheduling Params", "description": "Set schedule parameters abstract type.", "x-allOf-name": "scheduler.AbstractSchedulingParams", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "scheduler.AbstractTaskRequest": { "title": "Scheduler:Abstract Task Request", "description": "An abstract task request that can be extended to other types of task requests.", "x-allOf-name": "scheduler.AbstractTaskRequest", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "scheduler.BaseCadenceParams": { "title": "Scheduler:Base Cadence Params", "description": "The parameters for a onetime or recurring schedule.", "x-allOf-name": "scheduler.BaseCadenceParams", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "scheduler.BaseMonthlyCadenceParams": { "title": "Scheduler:Base Monthly Cadence Params", "description": "The monthly cadence applied to monthly schedules.", "x-allOf-name": "scheduler.BaseMonthlyCadenceParams", "allOf": [ { "$ref": "#/components/schemas/scheduler.BaseCadenceParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.BaseMonthlyCadenceParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "scheduler.MonthlyCadenceParams" ], "default": "scheduler.MonthlyCadenceParams", "x-enum-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": [ "scheduler.MonthlyCadenceParams" ], "default": "scheduler.MonthlyCadenceParams", "x-enum-as-string": true }, "RunEvery": { "description": "Run every month by default if not specified.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 12, "x-omitempty": true } } } ] }, "scheduler.BaseScheduleParams": { "title": "Scheduler:Base Schedule Params", "description": "Defines the base class for setting up schedule parameters.", "x-allOf-name": "scheduler.BaseScheduleParams", "allOf": [ { "$ref": "#/components/schemas/scheduler.AbstractSchedulingParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.BaseScheduleParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "scheduler.OneTimeScheduleParams", "scheduler.RecurringScheduleParams" ], "x-enum-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": [ "scheduler.OneTimeScheduleParams", "scheduler.RecurringScheduleParams" ], "x-enum-as-string": true }, "Duration": { "description": "The duration of the schedule. Its syntax is specified at https://www.w3.org/TR/xmlschema11-2/#nt-durationRep For example, P20DT10H5M2.3S is for 20 days, 10 hours, 5 minutes and 2.3 seconds. It is a mandatory input property for Policy based schedules.", "type": "string", "x-omitempty": true }, "Name": { "description": "The name of the schedule. It is a mandatory input property for Policy based schedules.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "StartTime": { "description": "The schedule start time. A future time is required.", "type": "string", "format": "date-time", "x-omitempty": true }, "TimeZone": { "description": "The timezone for the startTime specified. It is a mandatory input property when start time is provided.\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 } } } ] }, "scheduler.BlockDate": { "title": "Scheduler:Block Date", "description": "It represents a range of calendar dates during which scheduling functionality is restricted.\nThis is commonly used to not disrupt operations or schedule updates during these periods.\nThe timezone is set to the same timezone used for the schedule.", "x-allOf-name": "scheduler.BlockDate", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.BlockDate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.BlockDate" ], "default": "scheduler.BlockDate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.BlockDate" ], "default": "scheduler.BlockDate", "x-enum-as-string": true }, "EndTime": { "description": "The end date time of the block date.", "type": "string", "format": "date-time", "x-omitempty": true }, "StartTime": { "description": "The start date time of the block date.", "type": "string", "format": "date-time", "x-omitempty": true } } } ] }, "scheduler.DailyCadenceParams": { "title": "Scheduler:Daily Cadence Params", "description": "Parameters used for running daily (almost).", "x-allOf-name": "scheduler.DailyCadenceParams", "allOf": [ { "$ref": "#/components/schemas/scheduler.BaseCadenceParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.DailyCadenceParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.DailyCadenceParams" ], "default": "scheduler.DailyCadenceParams", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.DailyCadenceParams" ], "default": "scheduler.DailyCadenceParams", "x-enum-as-string": true }, "RunEvery": { "description": "Run every day by default if not specified.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 31, "x-omitempty": true } } } ] }, "scheduler.EveryCadenceParams": { "title": "Scheduler:Every Cadence Params", "description": "Specify a cadence as every time.ParseDuration format string.", "x-allOf-name": "scheduler.EveryCadenceParams", "allOf": [ { "$ref": "#/components/schemas/scheduler.BaseCadenceParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.EveryCadenceParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.EveryCadenceParams" ], "default": "scheduler.EveryCadenceParams", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.EveryCadenceParams" ], "default": "scheduler.EveryCadenceParams", "x-enum-as-string": true }, "Interval": { "description": "An interval specified as string where valid time units are \"s\", \"m\", \"h\". The minimum interval is 15 minutes and the maximum is 24 hours.", "type": "string", "x-omitempty": true } } } ] }, "scheduler.MonthlyCadenceParams": { "title": "Scheduler:Monthly Cadence Params", "description": "Used for a monthly cadence.", "x-allOf-name": "scheduler.MonthlyCadenceParams", "allOf": [ { "$ref": "#/components/schemas/scheduler.BaseMonthlyCadenceParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.MonthlyCadenceParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.MonthlyCadenceParams" ], "default": "scheduler.MonthlyCadenceParams", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.MonthlyCadenceParams" ], "default": "scheduler.MonthlyCadenceParams", "x-enum-as-string": true }, "CustomDayOfMonth": { "description": "Significant business days, such as days when reports are generated for analysis.\n* `None` - Placeholder. One of the following two fields must be selected.\n* `FirstWeekDay` - First week day of the month.\n* `MonthLastDay` - The last day of the month.\n* `FirstWeek` - Selected weekdays on first week of the month.\n* `SecondWeek` - Selected weekdays on second week of the month.\n* `ThirdWeek` - Selected weekdays on third week of the month.\n* `FourthWeek` - Selected weekdays on fourth week of the month.\n* `FifthWeek` - Selected weekdays on fifth week of the month.", "type": "string", "enum": [ "None", "FirstWeekDay", "MonthLastDay", "FirstWeek", "SecondWeek", "ThirdWeek", "FourthWeek", "FifthWeek" ], "default": "None", "x-omitempty": true }, "DayOfMonth": { "type": "array", "items": { "description": "A collection of days in a month.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true }, "DayOfWeek": { "type": "array", "items": { "description": "The days of week to schedule a task. If this is not provided, Monday is picked by default.\n* `Sunday` - The seventh day of the week.\n* `Monday` - The first day of the week.\n* `Tuesday` - The second day of the week.\n* `Wednesday` - The third day of the week.\n* `Thursday` - The fourth day of the week.\n* `Friday` - The fifth day of the week.\n* `Saturday` - The sixth day of the week.", "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "default": "Sunday", "x-omitempty": true }, "nullable": true } } } ] }, "scheduler.OneTimeScheduleParams": { "title": "Scheduler:One Time Schedule Params", "description": "The parameters for configuring a onetime schedule.", "x-allOf-name": "scheduler.OneTimeScheduleParams", "allOf": [ { "$ref": "#/components/schemas/scheduler.BaseScheduleParams" } ] }, "scheduler.RecurringScheduleParams": { "title": "Scheduler:Recurring Schedule Params", "description": "The parameters for configuring a recurring schedule.", "x-allOf-name": "scheduler.RecurringScheduleParams", "allOf": [ { "$ref": "#/components/schemas/scheduler.BaseScheduleParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.RecurringScheduleParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.RecurringScheduleParams" ], "default": "scheduler.RecurringScheduleParams", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.RecurringScheduleParams" ], "default": "scheduler.RecurringScheduleParams", "x-enum-as-string": true }, "Cadence": { "description": "Allowed values for a recurring schedule cadence.\n* `None` - No value set for the cadence type (Enum value None).\n* `Every` - Use the 'Every' cadence for tasks that need to be run frequently and are relatively small or quick to execute. This could include tasks such as checking the status of a service every 15 minutes, or updating a counter.\n* `Daily` - A Daily cadence allows for a scheduled task to be run every day or every n-interval days.\n* `Weekly` - A Weekly cadence allows for a scheduled task to be run every week or every n-interval weeks on specific days.\n* `Monthly` - A Montly cadence allows for a scheduled task to be run every month on specific days.", "type": "string", "enum": [ "None", "Every", "Daily", "Weekly", "Monthly" ], "default": "None", "x-omitempty": true }, "EndAfterOccurrences": { "description": "Specify the number of occurrences (instead of an end-time) for a recurring schedule.", "type": "integer", "format": "int64", "x-omitempty": true }, "EndTime": { "description": "End time for the recurring schedule. The schedule will not run beyond this time. If using the endAfterOccurrences parameter instead, this field should be set to zero time, i.e, 0001-01-01T00:00:00Z.", "type": "string", "format": "date-time", "x-omitempty": true }, "FailureThreshold": { "description": "The maximum number of consecutive failures until the recurring scheduled task is suspended by the system. The default is 1.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 10, "x-omitempty": true }, "Params": { "description": "The cadence for the recurring schedule. Different parameters are used depending on the schedule type.", "$ref": "#/components/schemas/scheduler.BaseCadenceParams", "x-omitempty": true } } } ] }, "scheduler.RestStimTaskRequest": { "title": "Scheduler:Rest Stim Task Request", "description": "The parameters for a reststim invoked by the scheduler.", "x-allOf-name": "scheduler.RestStimTaskRequest", "allOf": [ { "$ref": "#/components/schemas/scheduler.AbstractTaskRequest" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.RestStimTaskRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.RestStimTaskRequest" ], "default": "scheduler.RestStimTaskRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.RestStimTaskRequest" ], "default": "scheduler.RestStimTaskRequest", "x-enum-as-string": true }, "Body": { "description": "The request body that is sent as part of this API request.", "nullable": true, "x-omitempty": true }, "Headers": { "description": "Collection of key value pairs to set in the request header.", "nullable": true, "x-omitempty": true }, "Method": { "description": "The supported values are POST, PUT, DELETE, PATCH.", "type": "string", "x-omitempty": true }, "Protocol": { "description": "The accepted web protocol values are http and https.", "type": "string", "x-omitempty": true }, "Response": { "description": "The response obtained for the scheduled API service.", "deprecated": true, "x-sunset": "2027-03-01", "nullable": true, "x-omitempty": true }, "Timeout": { "description": "Upper limit on the execution time of a scheduled task. Helps purge run-away scheduled tasks.\nNot supported in this release.", "type": "integer", "format": "int64", "x-omitempty": true }, "Url": { "description": "The URL of the resource in the target to which the API request is made.", "type": "string", "x-omitempty": true } } } ] }, "scheduler.SchedulePolicy.Response": { "description": "The response body of a HTTP GET request for the 'scheduler.SchedulePolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'scheduler.SchedulePolicy' resources.", "x-one-of-name": "scheduler.SchedulePolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/scheduler.SchedulePolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "scheduler.SchedulePolicy.Relationship": { "description": "A relationship to the 'scheduler.SchedulePolicy' resource, or the expanded 'scheduler.SchedulePolicy' resource, or the 'null' value.", "x-one-of-name": "scheduler.SchedulePolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/scheduler.SchedulePolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "scheduler.SchedulePolicy": { "title": "Scheduler:Schedule Policy", "description": "SchedulePolicies define reusable, policy-based scheduling definitions for running tasks either one-time or on a recurring cadence. They encapsulate one or more schedule definitions (each with its own start time, timezone, duration, and cadence parameters) and can optionally enforce \u201cblock dates\u201d during which schedules must not run.\n#### Purpose\nProvide a centrally managed scheduling policy that can be attached to schedules or deployments so recurring operational actions (for example, workflow executions) run predictably and consistently across an organization.\n#### Key Concepts\n- **Policy-based scheduling:** A single policy can contain multiple schedule definitions, making scheduling reusable and standardized.\n- **One-time and recurring support:** Policies can describe schedules that execute once or on cadences like daily/weekly/monthly via typed schedule params.\n- **Block dates (blackout windows):** Optional block date intervals prevent execution during sensitive periods (maintenance freezes, change windows).\n- **Usage governance:** Tracks usage count so administrators can understand whether a policy is safe to delete (cannot delete when in use).\n- **Attachable association:** Maintains references to associated objects (e.g., task schedules and workload deployments) using the policy.", "x-allOf-name": "scheduler.SchedulePolicy", "allOf": [ { "$ref": "#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.SchedulePolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.SchedulePolicy" ], "default": "scheduler.SchedulePolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.SchedulePolicy" ], "default": "scheduler.SchedulePolicy", "x-enum-as-string": true }, "BlockDates": { "type": "array", "items": { "description": "A collection of block dates. The schedule will not run during this interval.", "$ref": "#/components/schemas/scheduler.BlockDate", "x-omitempty": true }, "nullable": true }, "EnableBlockDates": { "description": "Enable or disable block dates. If set to true, the schedule will not run during the block date interval.", "type": "boolean", "x-omitempty": true }, "ScheduleParams": { "type": "array", "items": { "description": "Schedule definitions for the policy. User can specify one or more schedules.", "$ref": "#/components/schemas/scheduler.BaseScheduleParams", "x-omitempty": true }, "minItems": 1, "nullable": true }, "UsageCount": { "description": "The number of profiles, templates and deployments that are using this policy. \nThis is used to determine if the policy can be deleted.\nIf the usageCount is greater than 0, the policy cannot be deleted.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AssociatedObjects": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "#/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 } } } ] }, "scheduler.SchedulePolicy.List": { "title": "List of 'scheduler.SchedulePolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'scheduler.SchedulePolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'scheduler.SchedulePolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/scheduler.SchedulePolicy" }, "nullable": true } } } ] }, "scheduler.TaskResult.Response": { "description": "The response body of a HTTP GET request for the 'scheduler.TaskResult' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'scheduler.TaskResult' resources.", "x-one-of-name": "scheduler.TaskResult.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/scheduler.TaskResult.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "scheduler.TaskResult": { "title": "Scheduler:Task Result", "description": "TaskResults represent individual execution instances produced by a TaskSchedule. For recurring schedules, each run yields a TaskResult record; for one-time schedules, there is typically a single result. TaskResults capture timing and outcome status information for auditing and troubleshooting.\n#### Purpose\nProvide per-run execution history for scheduled tasks so users and administrators can track success or failure over time and diagnose issues.\n#### Key Concepts\n- **Execution instance record:** One TaskResult per schedule run (many for recurring, one for one-time).\n- **Timing and duration visibility:** Captures start time, timezone, and end time for each execution.\n- **Outcome reporting:** Stores a structured status detail with state and reason for failure or suspension.\n- **Backreference to schedule:** Always linked to the TaskSchedule that produced it (cascade delete with the schedule).\n- **Associated object pointer:** Can reference the managed object created/updated by the run (e.g., a workflow execution record).", "x-allOf-name": "scheduler.TaskResult", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.TaskResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.TaskResult" ], "default": "scheduler.TaskResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.TaskResult" ], "default": "scheduler.TaskResult", "x-enum-as-string": true }, "EndTime": { "description": "End time for the scheduled task.", "type": "string", "format": "date-time", "x-omitempty": true }, "StartTime": { "description": "Start time for the scheduled task.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "StatusDetail": { "description": "Status of the schedule task.", "$ref": "#/components/schemas/scheduler.TaskResultStatus", "readOnly": true, "x-omitempty": true }, "TimeZone": { "description": "The timezone for the startTime specified.\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 }, "AssociatedObject": { "$ref": "#/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 }, "TaskSchedule": { "$ref": "#/components/schemas/scheduler.TaskSchedule.Relationship", "description": "A reference to a schedulerTaskSchedule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "scheduler.TaskResult.List": { "title": "List of 'scheduler.TaskResult' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'scheduler.TaskResult' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'scheduler.TaskResult' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/scheduler.TaskResult" }, "nullable": true } } } ] }, "scheduler.TaskResultStatus": { "title": "Scheduler:Task Result Status", "description": "The status of a single instance of the scheduled task.", "x-allOf-name": "scheduler.TaskResultStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.TaskResultStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.TaskResultStatus" ], "default": "scheduler.TaskResultStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.TaskResultStatus" ], "default": "scheduler.TaskResultStatus", "x-enum-as-string": true }, "Reason": { "description": "The status reason, used when a scheduled task fails or was suspended by the system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the current scheduled task.\n* `None` - No status is set (default).\n* `Scheduled` - The status is set when a task is scheduled.\n* `Running` - The status is set when a task is running.\n* `Completed` - The status is set when a task is complete.\n* `Failed` - The status is set when a task fails.\n* `Suspended` - The status is set when a task is suspended.\n* `Skipped` - The status is set when a task is skipped because the previous task is still running.", "type": "string", "enum": [ "None", "Scheduled", "Running", "Completed", "Failed", "Suspended", "Skipped" ], "default": "None", "readOnly": true, "x-omitempty": true } } } ] }, "scheduler.TaskSchedule.Response": { "description": "The response body of a HTTP GET request for the 'scheduler.TaskSchedule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'scheduler.TaskSchedule' resources.", "x-one-of-name": "scheduler.TaskSchedule.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/scheduler.TaskSchedule.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "scheduler.TaskSchedule.Relationship": { "description": "A relationship to the 'scheduler.TaskSchedule' resource, or the expanded 'scheduler.TaskSchedule' resource, or the 'null' value.", "x-one-of-name": "scheduler.TaskSchedule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/scheduler.TaskSchedule" } ], "discriminator": { "propertyName": "ClassId" } }, "scheduler.TaskSchedule": { "title": "Scheduler:Task Schedule", "description": "TaskSchedules are the runtime scheduling objects that drive one-time or recurring executions. A TaskSchedule can run directly using explicit schedule parameters or can be \u201cpolicy-based\u201d by referencing a SchedulePolicy. It also defines what to execute (a REST-stim task request and/or an associated workflow definition) and tracks current scheduling status.\n#### Purpose\nCreate and manage scheduled executions including lifecycle actions like suspend or resume, while exposing current and historical execution status.\n#### Key Concepts\n- **Schedule orchestration:** Combines *when to run* (schedule params or referenced policy) with *what to run* (task request or workflow definition).\n- **Policy-backed vs direct schedules:** `usePolicy` determines whether execution timing comes from a SchedulePolicy or inline schedule params.\n- **Lifecycle actions:** Supports operational actions like suspend or resume (and captures the last applied action).\n- **Status and execution telemetry:** Exposes next or previous run timestamps, counters (completed, failed, or skipped), and suspension reasons.\n- **Permission inheritance from target:** Inherits permissions from an `associatedObject`, ensuring schedule management aligns with the governed resource.", "x-allOf-name": "scheduler.TaskSchedule", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.TaskSchedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.TaskSchedule" ], "default": "scheduler.TaskSchedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.TaskSchedule" ], "default": "scheduler.TaskSchedule", "x-enum-as-string": true }, "Action": { "description": "The action of the scheduled task such as suspend or resume.\n* `None` - No action is set (default).\n* `Suspend` - Suspend a scheduled task indefinitely.\n* `Resume` - Resume a suspended scheduled task.\n* `SuspendTill` - Suspend the scheduled task until a specified end-date. Not supported in this release.", "type": "string", "enum": [ "None", "Suspend", "Resume", "SuspendTill" ], "default": "None", "x-omitempty": true }, "Description": { "description": "A description to describe the schedule for easier identification.", "type": "string", "x-omitempty": true }, "ExecutionStatuses": { "type": "array", "items": { "description": "The execution status of the current task schedule for Policy based schedules.", "$ref": "#/components/schemas/scheduler.TaskSchedulePolicyExecutionStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "LastAction": { "description": "The last action for the scheduled task is saved in this field. Set to none if there was no action.\n* `None` - No action is set (default).\n* `Suspend` - Suspend a scheduled task indefinitely.\n* `Resume` - Resume a suspended scheduled task.\n* `SuspendTill` - Suspend the scheduled task until a specified end-date. Not supported in this release.", "type": "string", "enum": [ "None", "Suspend", "Resume", "SuspendTill" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Name": { "description": "A schedule name for easier identification (not required to be unique).", "type": "string", "x-omitempty": true }, "ScheduleParams": { "description": "According to the schedule type this property is evaluated. If the property Type is set to OneTime, then the ObjectType must be scheduler.OneTimeScheduleParams. If the Type is Recurring, then the ObjectType must be scheduler.RecurringScheduleParams.", "$ref": "#/components/schemas/scheduler.BaseScheduleParams", "x-omitempty": true }, "Status": { "description": "Status of the current scheduled task.", "$ref": "#/components/schemas/scheduler.TaskScheduleStatus", "readOnly": true, "x-omitempty": true }, "SubmittedBy": { "description": "Email address of the user who created the schedule.", "type": "string", "readOnly": true, "x-omitempty": true }, "SuspendEndTime": { "description": "Suspend a task until an end date. this applies only to the action suspendTill.", "type": "string", "format": "date-time", "x-omitempty": true }, "TaskRequest": { "description": "According to the schedule type the recurring params are populated.", "$ref": "#/components/schemas/scheduler.RestStimTaskRequest", "x-omitempty": true }, "Type": { "description": "An Enum describing the type of scheduler to use.\n* `None` - No value was set for the schedule type (Enum value None).\n* `OneTime` - Define a one-time task execution time that will not automatically repeat.\n* `Recurring` - Specify a recurring task cadence based on a predefined pattern, such as daily, weekly, monthly, or every pattern.", "type": "string", "enum": [ "None", "OneTime", "Recurring" ], "default": "None", "x-omitempty": true }, "UsePolicy": { "description": "Indicates if the schedule is policy based or not.", "type": "boolean", "default": false, "x-createOnly": true, "x-omitempty": true }, "AssociatedObject": { "$ref": "#/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 }, "Policy": { "$ref": "#/components/schemas/scheduler.SchedulePolicy.Relationship", "description": "A reference to a schedulerSchedulePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "WorkflowDefinition": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowDefinition.Relationship", "description": "A reference to a workflowWorkflowDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "scheduler.TaskSchedule.List": { "title": "List of 'scheduler.TaskSchedule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'scheduler.TaskSchedule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'scheduler.TaskSchedule' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/scheduler.TaskSchedule" }, "nullable": true } } } ] }, "scheduler.TaskSchedulePolicyExecutionStatus": { "title": "Scheduler:Task Schedule Policy Execution Status", "description": "The scheduled Task execution status per schedule defined in SchedulePolicy.", "x-allOf-name": "scheduler.TaskSchedulePolicyExecutionStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.TaskSchedulePolicyExecutionStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.TaskSchedulePolicyExecutionStatus" ], "default": "scheduler.TaskSchedulePolicyExecutionStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.TaskSchedulePolicyExecutionStatus" ], "default": "scheduler.TaskSchedulePolicyExecutionStatus", "x-enum-as-string": true }, "Name": { "description": "Name of the schedule defined in SchedulePolicy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the scheduled task.", "$ref": "#/components/schemas/scheduler.TaskScheduleStatus", "readOnly": true, "x-omitempty": true } } } ] }, "scheduler.TaskScheduleStatus": { "title": "Scheduler:Task Schedule Status", "description": "The scheduled task details.", "x-allOf-name": "scheduler.TaskScheduleStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.TaskScheduleStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.TaskScheduleStatus" ], "default": "scheduler.TaskScheduleStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.TaskScheduleStatus" ], "default": "scheduler.TaskScheduleStatus", "x-enum-as-string": true }, "CompletedCount": { "description": "The count of tasks that ran to successful completion.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ConsecutiveFailures": { "description": "The number of consecutive times the task has failed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Count": { "description": "The task completion count, which includes both successful executions and any failures.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CurrentStatus": { "description": "The status of the current task.\n* `None` - No status is set (default).\n* `Scheduled` - The status is set when a task is scheduled.\n* `Running` - The status is set when a task is running.\n* `Completed` - The status is set when a task is complete.\n* `Failed` - The status is set when a task fails.\n* `Suspended` - The status is set when a task is suspended.\n* `Skipped` - The status is set when a task is skipped because the previous task is still running.", "type": "string", "enum": [ "None", "Scheduled", "Running", "Completed", "Failed", "Suspended", "Skipped" ], "default": "None", "readOnly": true, "x-omitempty": true }, "FailedCount": { "description": "The count of tasks that failed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IsSystemSuspended": { "description": "The flag if set to true means it was suspended by the system.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LastRunStatus": { "description": "The last task completion status, which includes both successful executions and any failures.\n* `None` - No status is set (default).\n* `Scheduled` - The status is set when a task is scheduled.\n* `Running` - The status is set when a task is running.\n* `Completed` - The status is set when a task is complete.\n* `Failed` - The status is set when a task fails.\n* `Suspended` - The status is set when a task is suspended.\n* `Skipped` - The status is set when a task is skipped because the previous task is still running.", "type": "string", "enum": [ "None", "Scheduled", "Running", "Completed", "Failed", "Suspended", "Skipped" ], "default": "None", "readOnly": true, "x-omitempty": true }, "NextRunStartTime": { "description": "The next run time for a recurrently scheduled the task.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "PrevRunEndTime": { "description": "The time when the last occurrence of scheduled task completed.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "PrevRunStartTime": { "description": "The previous time the scheduled task was run.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "The reason why the task failed or suspended.", "type": "string", "readOnly": true, "x-omitempty": true }, "SkippedCount": { "description": "The count of tasks that were skipped.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "scheduler.WeeklyCadenceParams": { "title": "Scheduler:Weekly Cadence Params", "description": "Parameters used for weekly cadence.", "x-allOf-name": "scheduler.WeeklyCadenceParams", "allOf": [ { "$ref": "#/components/schemas/scheduler.BaseCadenceParams" }, { "type": "object", "description": "Definition of the list of properties defined in 'scheduler.WeeklyCadenceParams', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "scheduler.WeeklyCadenceParams" ], "default": "scheduler.WeeklyCadenceParams", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "scheduler.WeeklyCadenceParams" ], "default": "scheduler.WeeklyCadenceParams", "x-enum-as-string": true }, "DayOfWeek": { "type": "array", "items": { "description": "The days of week to schedule a task. If this is not provided, Monday is picked by default.\n* `Sunday` - The seventh day of the week.\n* `Monday` - The first day of the week.\n* `Tuesday` - The second day of the week.\n* `Wednesday` - The third day of the week.\n* `Thursday` - The fourth day of the week.\n* `Friday` - The fifth day of the week.\n* `Saturday` - The sixth day of the week.", "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "default": "Sunday", "x-omitempty": true }, "nullable": true }, "RunEvery": { "description": "A weekly interval for a task execution. If an interval is not explicitly specified, the task will be executed once every week by default.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 52, "x-omitempty": true } } } ] }, "sdaaci.Connection.Response": { "description": "The response body of a HTTP GET request for the 'sdaaci.Connection' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'sdaaci.Connection' resources.", "x-one-of-name": "sdaaci.Connection.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/sdaaci.Connection.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "sdaaci.Connection.Relationship": { "description": "A relationship to the 'sdaaci.Connection' resource, or the expanded 'sdaaci.Connection' resource, or the 'null' value.", "x-one-of-name": "sdaaci.Connection.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/sdaaci.Connection" } ], "discriminator": { "propertyName": "ClassId" } }, "sdaaci.Connection": { "title": "Sdaaci:Connection", "description": "The Connection object is an integral part of the network management system, designed to facilitate the establishment and management of direct connections between SDA and ACI environments. This provides a structured approach to configure and monitor network connections, ensuring seamless integration and communication between different network domains.\n#### Purpose\nA Connection object represents the configuration and status of a direct link between SDA and ACI systems. It is responsible for managing VN and EPG configurations, facilitating network communication, and ensuring connectivity compliance with organizational requirements.\n#### Key Concepts\n- **Connectivity Management:** Enables the configuration of connection parameters such as VN, EPG, and ACI tenant details, ensuring the network is set up correctly.\n- **Status Monitoring:** Tracks the connection status, providing real-time updates on connectivity health and issues.\n- **Multi-Component Integration:** Integrates with various network components, including campus fabrics, ACI tenants, and firewalls, supporting comprehensive network management.\n- **APIC Integration:** Facilitates seamless interaction with APIC environments, ensuring efficient management and configuration of ACI resources.", "x-allOf-name": "sdaaci.Connection", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'sdaaci.Connection', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sdaaci.Connection" ], "default": "sdaaci.Connection", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sdaaci.Connection" ], "default": "sdaaci.Connection", "x-enum-as-string": true }, "AciL3Out": { "description": "User input for ACI L3Out name.", "type": "string", "x-omitempty": true }, "AciMatchRuleName": { "description": "Match rule name in Cisco APIC.", "type": "string", "x-omitempty": true }, "AciTenant": { "description": "ACI tenant name for the selected APIC target.", "type": "string", "x-omitempty": true }, "CampusFabricSite": { "description": "Campus fabric site Id where the border node is configured.", "type": "string", "x-omitempty": true }, "Epg": { "description": "Application EPG name for this connection.", "type": "string", "x-omitempty": true }, "EpgSubnet": { "description": "EPG Subnet Ipv4Cidr configured on APIC.", "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])\\/([0-9]|[1-2][0-9]|3[0-2])$", "x-omitempty": true }, "FirewallDevice": { "description": "Device within the selected domain used for firewall configuration.", "type": "string", "x-omitempty": true }, "FirewallDomain": { "description": "Domain used for firewall configuration.", "type": "string", "x-omitempty": true }, "NodeProfile": { "description": "L3Out node profile in Cisco APIC.", "type": "string", "x-omitempty": true }, "Status": { "description": "Connection status between SDA and ACI.\n* `NotConnected` - Status of the connection:Not connected.\n* `Connected` - Status of the connection:Connected.", "type": "string", "enum": [ "NotConnected", "Connected" ], "default": "NotConnected", "x-omitempty": true }, "Transit": { "description": "Transit Id for the given border node.", "type": "string", "x-omitempty": true }, "VirtualNetwork": { "description": "Virtual Network for this connection.", "type": "string", "x-omitempty": true }, "VnEpg": { "description": "VN and EPG information for this connection.", "type": "string", "x-omitempty": true }, "Vrf": { "description": "Tenant VRF in Cisco APIC.", "type": "string", "x-omitempty": true }, "ApicTarget": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "CatalystCenterTarget": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "FmcTarget": { "$ref": "#/components/schemas/asset.Target.Relationship", "description": "A reference to a assetTarget resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "#/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 } } } ] }, "sdaaci.Connection.List": { "title": "List of 'sdaaci.Connection' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'sdaaci.Connection' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'sdaaci.Connection' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/sdaaci.Connection" }, "nullable": true } } } ] }, "sdaaci.ConnectionDetail.Response": { "description": "The response body of a HTTP GET request for the 'sdaaci.ConnectionDetail' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'sdaaci.ConnectionDetail' resources.", "x-one-of-name": "sdaaci.ConnectionDetail.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/sdaaci.ConnectionDetail.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "sdaaci.ConnectionDetail": { "title": "Sdaaci:Connection Detail", "description": "Peer connection details for all connections.", "x-allOf-name": "sdaaci.ConnectionDetail", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'sdaaci.ConnectionDetail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sdaaci.ConnectionDetail" ], "default": "sdaaci.ConnectionDetail", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sdaaci.ConnectionDetail" ], "default": "sdaaci.ConnectionDetail", "x-enum-as-string": true }, "Description": { "description": "Description of the connection between the two peers.", "type": "string", "x-omitempty": true }, "IpPool": { "description": "Ip pool Id configured for this connection.", "type": "string", "x-omitempty": true }, "Layer3HandoffId": { "description": "Layer 3 handoff Id configured between a border node and a border leaf.", "type": "string", "x-omitempty": true }, "PeerAinterface": { "description": "Interface Id configured on Peer A.", "type": "string", "x-omitempty": true }, "PeerAipAddress": { "description": "IP address of the device used as the local peer.", "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])\\/([0-9]|[1-2][0-9]|3[0-2])$", "x-omitempty": true }, "PeerAtype": { "description": "Type of device used as Peer A in this peer connection.", "type": "string", "x-omitempty": true }, "PeerBinterface": { "description": "Interface Id configured on Peer B.", "type": "string", "x-omitempty": true }, "PeerBipAddress": { "description": "IP address of the device used as the remote peer.", "type": "string", "x-omitempty": true }, "PeerBtype": { "description": "Type of device used as Peer B in this peer connection.", "type": "string", "x-omitempty": true }, "Peera": { "description": "First peer in the connection.", "type": "string", "x-omitempty": true }, "Peerb": { "description": "Second peer in the connection.", "type": "string", "x-omitempty": true }, "RouterId": { "description": "Router Id defined for this peer connection.", "type": "string", "x-omitempty": true }, "Status": { "description": "Connection status between the peers.\n* `NotConnected` - Status of the connection:Not connected.\n* `Connected` - Status of the connection:Connected.", "type": "string", "enum": [ "NotConnected", "Connected" ], "default": "NotConnected", "x-omitempty": true }, "Connection": { "$ref": "#/components/schemas/sdaaci.Connection.Relationship", "description": "A reference to a sdaaciConnection resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "sdaaci.ConnectionDetail.List": { "title": "List of 'sdaaci.ConnectionDetail' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'sdaaci.ConnectionDetail' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'sdaaci.ConnectionDetail' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/sdaaci.ConnectionDetail" }, "nullable": true } } } ] }, "search.SearchItem.Response": { "description": "The response body of a HTTP GET request for the 'search.SearchItem' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'search.SearchItem' resources.", "x-one-of-name": "search.SearchItem.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/search.SearchItem.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "search.SearchItem": { "title": "Search:Search Item", "description": "The SearchItem object represents an entry point for searching Intersight REST resources. It enables users to query and retrieve data using the OData query syntax, providing a standardized and flexible method for resource discovery within the system.\n#### Purpose\nA SearchItem serves as the primary interface for performing structured searches across various Intersight resources. Its purpose is to facilitate efficient data retrieval by allowing users to construct complex queries based on OData syntax, thereby enabling precise filtering, ordering, and selection of desired information.\n#### Key Concepts\n- **Resource Discovery:** Designed to help users locate and access specific REST resources within the Intersight environment.\n- **API Entry Point:** Functions as a dedicated endpoint for initiating search operations, streamlining the process of data lookup.", "x-allOf-name": "search.SearchItem", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" } ] }, "search.SearchItem.List": { "title": "List of 'search.SearchItem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'search.SearchItem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'search.SearchItem' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/search.SearchItem" }, "nullable": true } } } ] }, "search.TagItem.Response": { "description": "The response body of a HTTP GET request for the 'search.TagItem' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'search.TagItem' resources.", "x-one-of-name": "search.TagItem.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/search.TagItem.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "search.TagItem": { "title": "Search:Tag Item", "description": "The TagItem object serves as an entry point for searching tags associated with Intersight REST resources. It allows users to query and discover tags across the system using OData Query syntax, providing a mechanism for organizing and categorizing resources.\n#### Purpose\nThe purpose of a TagItem is to enable efficient discovery and management of tags applied to various Intersight resources. This provides a centralized way to search for specific tags and understand their prevalence and associated values across the system, facilitating resource organization and retrieval based on custom metadata.\n#### Key Concepts\n- **Tag-Based Search:** Specializes in querying resources based on their assigned tags, offering an alternative or supplementary search method to direct resource queries.\n- **Metadata Organization:** Supports the systematic organization and classification of Intersight resources through tagging.", "x-allOf-name": "search.TagItem", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'search.TagItem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "search.TagItem" ], "default": "search.TagItem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "search.TagItem" ], "default": "search.TagItem", "x-enum-as-string": true }, "Count": { "description": "The number of times this tag key has been set across all resources.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Key": { "description": "Key of the tag from all the resources in Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ext_Moid": { "description": "The unique identifier of the tag definition managed object. Refer to the comm.TagDefinition API.", "type": "string", "readOnly": true, "x-omitempty": true }, "TaggedObjectTypes": { "type": "array", "items": { "description": "Unique list of object types that have this tag key set.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Type": { "description": "Type of the tag definition. Refer to comm.TagDefinitionType API.", "type": "string", "readOnly": true, "x-omitempty": true }, "Values": { "type": "array", "items": { "description": "All values corresponding to the tag key in the results.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "search.TagItem.List": { "title": "List of 'search.TagItem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'search.TagItem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'search.TagItem' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/search.TagItem" }, "nullable": true } } } ] }, "serviceitem.BaseMessage": { "title": "Serviceitem:Base Message", "description": "BaseMessage holds the common set of properties that are logged across CatalogServiceRequest, and ServiceItemActionInstance. The messages can be of different severity levels and hence messages are created for successful or unsuccessful executions.", "x-allOf-name": "serviceitem.BaseMessage", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'serviceitem.BaseMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "serviceitem.Message", "servicerequest.Message" ], "x-enum-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": [ "serviceitem.Message", "servicerequest.Message" ], "x-enum-as-string": true }, "ActionOperation": { "description": "The type of action instance operation, such as Validate, Start, Retry, RetryFailed, Cancel, Stop etc.\n* `None` - No action is set, this is the default value for action field.\n* `Validate` - Validate the action instance inputs and run the validation workflows.\n* `Start` - Start a new execution of the action instance.\n* `Rerun` - Rerun the service item action instance from the beginning.\n* `Retry` - Retry the workflow that has failed from the failure point.\n* `Cancel` - Cancel the core workflow that is in running or waiting state. This action can be used when the workflows are stuck and not progressing.\n* `Stop` - Stop the action instance which is in progress and didn't complete successfully. Use this action to clear the state and then delete the action instance. A completed action cannot be stopped.", "type": "string", "enum": [ "None", "Validate", "Start", "Rerun", "Retry", "Cancel", "Stop" ], "default": "None", "readOnly": true, "x-omitempty": true }, "CreateTime": { "description": "The timestamp when the message was created.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Message": { "description": "An i18n message which can be localized and conveys status on the action.", "type": "string", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "The severity of the message such as error, warning, info etc.\n* `Info` - The enum represents the log level to be used to convey info message.\n* `Warning` - The enum represents the log level to be used to convey warning message.\n* `Debug` - The enum represents the log level to be used to convey debug message.\n* `Error` - The enum represents the log level to be used to convey error message.", "type": "string", "enum": [ "Info", "Warning", "Debug", "Error" ], "default": "Info", "readOnly": true, "x-omitempty": true } } } ] }, "serviceitem.HealthCheckErrorElement": { "title": "Serviceitem:Health Check Error Element", "description": "Details about the service item elements of particular type (eg. Server, Storage, etc.) for which the health check has failed.", "x-allOf-name": "serviceitem.HealthCheckErrorElement", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'serviceitem.HealthCheckErrorElement', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "serviceitem.HealthCheckErrorElement" ], "default": "serviceitem.HealthCheckErrorElement", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "serviceitem.HealthCheckErrorElement" ], "default": "serviceitem.HealthCheckErrorElement", "x-enum-as-string": true }, "ElementType": { "description": "Type of the element of the service item. Examples are Server, Storage, UCS Fabric Interconnect etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "Elements": { "type": "array", "items": { "description": "Array of the service item elements of specific type.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "serviceitem.Message": { "title": "Serviceitem:Message", "description": "The instance status message can be used at ServiceItemInstance and ServiceItemActionInstance level.", "x-allOf-name": "serviceitem.Message", "allOf": [ { "$ref": "#/components/schemas/serviceitem.BaseMessage" } ] }, "serviceitem.SelectionCriteriaInput": { "title": "Serviceitem:Selection Criteria Input", "description": "The policy based input is available at service item action definition and catalog item which is evaluated at runtime, SelectionCriteriaInput is used to capture the input which is extracted and possible condition is used to extract the value is captured.", "x-allOf-name": "serviceitem.SelectionCriteriaInput", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'serviceitem.SelectionCriteriaInput', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "serviceitem.SelectionCriteriaInput" ], "default": "serviceitem.SelectionCriteriaInput", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "serviceitem.SelectionCriteriaInput" ], "default": "serviceitem.SelectionCriteriaInput", "x-enum-as-string": true }, "FilterConditions": { "type": "array", "items": { "description": "The collection of filter condition used to extract the value.", "$ref": "#/components/schemas/resource.Selector", "readOnly": true, "x-omitempty": true }, "nullable": true }, "InputName": { "description": "Name of the Policy Input.", "type": "string", "readOnly": true, "x-omitempty": true }, "InputValue": { "description": "The value extracted from the filter conditions.", "nullable": true, "readOnly": true, "x-omitempty": true } } } ] }, "servicerequest.Message": { "title": "Servicerequest:Message", "description": "The instance status message can be used at CatalogServiceRequest level.", "x-allOf-name": "servicerequest.Message", "allOf": [ { "$ref": "#/components/schemas/serviceitem.BaseMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'servicerequest.Message', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "servicerequest.Message" ], "default": "servicerequest.Message", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "servicerequest.Message" ], "default": "servicerequest.Message", "x-enum-as-string": true }, "ServiceItemName": { "description": "The service item in which operation is perfomed.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "session.AbstractSession.Relationship": { "description": "A relationship to the 'session.AbstractSession' resource, or the expanded 'session.AbstractSession' resource, or the 'null' value.", "x-one-of-name": "session.AbstractSession.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/session.AbstractSession" } ], "discriminator": { "propertyName": "ClassId" } }, "session.AbstractSession": { "title": "Session:Abstract Session", "description": "A base abstract class for all sessions.", "x-allOf-name": "session.AbstractSession", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'session.AbstractSession', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "iam.Session", "kvm.Session", "kvm.Tunnel", "virtualization.EsxiConsole", "vmrc.Console" ], "x-enum-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": [ "iam.Session", "kvm.Session", "kvm.Tunnel", "virtualization.EsxiConsole", "vmrc.Console" ], "x-enum-as-string": true }, "ClientIpAddress": { "description": "The user agent IP address from which the session is launched.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndTime": { "description": "The time at which the session ended.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Role": { "description": "Role of the user who launched the session.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the session.\n* `Active` - The session is currently active.\n* `Ended` - The session has ended normally.\n* `Terminated` - The session was terminated by an admin.", "type": "string", "enum": [ "Active", "Ended", "Terminated" ], "default": "Active", "x-omitempty": true }, "UserIdOrEmail": { "description": "User ID or E-mail Address of the user who launched the session.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "session.AbstractSubSession": { "title": "Session:Abstract Sub Session", "description": "A base abstract class for all sub-sessions.", "x-allOf-name": "session.AbstractSubSession", "allOf": [ { "$ref": "#/components/schemas/session.AbstractSession" }, { "type": "object", "description": "Definition of the list of properties defined in 'session.AbstractSubSession', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "kvm.Session", "kvm.Tunnel", "virtualization.EsxiConsole", "vmrc.Console" ], "x-enum-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": [ "kvm.Session", "kvm.Tunnel", "virtualization.EsxiConsole", "vmrc.Console" ], "x-enum-as-string": true }, "TargetName": { "description": "Name of target on which session is initiated.", "type": "string", "readOnly": true, "x-omitempty": true }, "Session": { "$ref": "#/components/schemas/session.AbstractSession.Relationship", "description": "A reference to a sessionAbstractSession resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Target": { "$ref": "#/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 }, "User": { "$ref": "#/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 } } } ] }, "software.ApplianceDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.ApplianceDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.ApplianceDistributable' resources.", "x-one-of-name": "software.ApplianceDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.ApplianceDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.ApplianceDistributable": { "title": "Appliance Software", "description": "The ApplianceDistributable object represents an appliance image distributed by Cisco. It is designed for upgrading on-premise Intersight Appliances, supporting both SaaS and appliance deployments.\n#### Purpose\nApplianceDistributable serves as a downloadable image for SaaS environments and a user-uploaded image for on-premise upgrades, ensuring that Intersight Appliances remain up-to-date.\n#### Key Concepts\n- **Upgrade Facilitation:** Provides the necessary images for upgrading Intersight Appliances, maintaining system performance and security.\n- **Dual Use:** Supports SaaS downloadable images and on-premise appliance upgrades, offering flexibility.\n- **Management Integration:** Integrates with the Intersight catalog to ensure seamless upgrade processes.\n- **System Support:** Ensures that appliances receive essential updates to support ongoing operations.", "x-allOf-name": "software.ApplianceDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.ApplianceDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.ApplianceDistributable" ], "default": "software.ApplianceDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.ApplianceDistributable" ], "default": "software.ApplianceDistributable", "x-enum-as-string": true }, "Catalog": { "$ref": "#/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 } } } ] }, "software.ApplianceDistributable.List": { "title": "List of 'software.ApplianceDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.ApplianceDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.ApplianceDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.ApplianceDistributable" }, "nullable": true } } } ] }, "software.DownloadHistory.Response": { "description": "The response body of a HTTP GET request for the 'software.DownloadHistory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.DownloadHistory' resources.", "x-one-of-name": "software.DownloadHistory.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.DownloadHistory.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.DownloadHistory": { "title": "Software Download History", "description": "An object to keep track of software downloads from the Private Appliance portal in SaaS.", "x-allOf-name": "software.DownloadHistory", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.DownloadHistory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.DownloadHistory" ], "default": "software.DownloadHistory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.DownloadHistory" ], "default": "software.DownloadHistory", "x-enum-as-string": true }, "Name": { "description": "The name of software which was downloaded.", "type": "string", "readOnly": true, "x-omitempty": true }, "Product": { "description": "The product type of the downloaded software.", "type": "string", "x-omitempty": true }, "Timestamp": { "description": "The download time of the software image.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "UserIdOrEmail": { "description": "The email id of the user who initiated the software download.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of software which was downloaded.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 }, "Image": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable.Relationship", "description": "A reference to a firmwareBaseDistributable resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "software.DownloadHistory.List": { "title": "List of 'software.DownloadHistory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.DownloadHistory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.DownloadHistory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.DownloadHistory" }, "nullable": true } } } ] }, "software.HciBundleDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.HciBundleDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.HciBundleDistributable' resources.", "x-one-of-name": "software.HciBundleDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.HciBundleDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.HciBundleDistributable": { "title": "HCI Bundle", "description": "An HCI image bundle distributed by Cisco for Private Appliance.", "x-allOf-name": "software.HciBundleDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.HciBundleDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.HciBundleDistributable" ], "default": "software.HciBundleDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.HciBundleDistributable" ], "default": "software.HciBundleDistributable", "x-enum-as-string": true }, "Catalog": { "$ref": "#/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 }, "Images": { "description": "An array of relationships to softwareHciDistributable resources.", "type": "array", "items": { "$ref": "#/components/schemas/software.HciDistributable.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "software.HciBundleDistributable.List": { "title": "List of 'software.HciBundleDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.HciBundleDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.HciBundleDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.HciBundleDistributable" }, "nullable": true } } } ] }, "software.HciDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.HciDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.HciDistributable' resources.", "x-one-of-name": "software.HciDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.HciDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.HciDistributable.Relationship": { "description": "A relationship to the 'software.HciDistributable' resource, or the expanded 'software.HciDistributable' resource, or the 'null' value.", "x-one-of-name": "software.HciDistributable.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/software.HciDistributable" } ], "discriminator": { "propertyName": "ClassId" } }, "software.HciDistributable": { "title": "HCI", "description": "An HCI image distributed by Cisco.", "x-allOf-name": "software.HciDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.HciDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.HciDistributable" ], "default": "software.HciDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.HciDistributable" ], "default": "software.HciDistributable", "x-enum-as-string": true }, "MetaInfo": { "description": "Additional information associated with the distributable object. This data is provided as a JSON blob by Nutanix, a partner vendor, and the format is not fixed.", "nullable": true, "readOnly": true, "x-omitempty": true }, "Catalog": { "$ref": "#/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 } } } ] }, "software.HciDistributable.List": { "title": "List of 'software.HciDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.HciDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.HciDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.HciDistributable" }, "nullable": true } } } ] }, "software.HclMeta.Response": { "description": "The response body of a HTTP GET request for the 'software.HclMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.HclMeta' resources.", "x-one-of-name": "software.HclMeta.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.HclMeta.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.HclMeta": { "title": "Json For Hcl Meta", "description": "A JSON file wth HCL metadata uploaded for consumption by the HCL service.", "x-allOf-name": "software.HclMeta", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.HclMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.HclMeta" ], "default": "software.HclMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.HclMeta" ], "default": "software.HclMeta", "x-enum-as-string": true }, "ContentType": { "description": "The type of content that the Json file holds (Incremental or full dump).\n* `Full` - Indicates that the JSON File does have full content for HCL metadata.\n* `Incremental` - Indicates that the JSON File does have only the diff of the Hcl meta to be uploaded.", "type": "string", "enum": [ "Full", "Incremental" ], "default": "Full", "x-omitempty": true }, "Catalog": { "$ref": "#/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 } } } ] }, "software.HclMeta.List": { "title": "List of 'software.HclMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.HclMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.HclMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.HclMeta" }, "nullable": true } } } ] }, "software.HyperflexBundleDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.HyperflexBundleDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.HyperflexBundleDistributable' resources.", "x-one-of-name": "software.HyperflexBundleDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.HyperflexBundleDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.HyperflexBundleDistributable": { "title": "HyperFlex Bundle", "description": "A HyperFlex image bundle distributed by Cisco for Private Appliance.", "x-allOf-name": "software.HyperflexBundleDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.HyperflexBundleDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.HyperflexBundleDistributable" ], "default": "software.HyperflexBundleDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.HyperflexBundleDistributable" ], "default": "software.HyperflexBundleDistributable", "x-enum-as-string": true }, "Catalog": { "$ref": "#/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 }, "Images": { "description": "An array of relationships to softwareHyperflexDistributable resources.", "type": "array", "items": { "$ref": "#/components/schemas/software.HyperflexDistributable.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "software.HyperflexBundleDistributable.List": { "title": "List of 'software.HyperflexBundleDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.HyperflexBundleDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.HyperflexBundleDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.HyperflexBundleDistributable" }, "nullable": true } } } ] }, "software.HyperflexDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.HyperflexDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.HyperflexDistributable' resources.", "x-one-of-name": "software.HyperflexDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.HyperflexDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.HyperflexDistributable.Relationship": { "description": "A relationship to the 'software.HyperflexDistributable' resource, or the expanded 'software.HyperflexDistributable' resource, or the 'null' value.", "x-one-of-name": "software.HyperflexDistributable.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/software.HyperflexDistributable" } ], "discriminator": { "propertyName": "ClassId" } }, "software.HyperflexDistributable": { "title": "HyperFlex", "description": "A HyperFlex image distributed by Cisco.", "x-allOf-name": "software.HyperflexDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.HyperflexDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.HyperflexDistributable" ], "default": "software.HyperflexDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.HyperflexDistributable" ], "default": "software.HyperflexDistributable", "x-enum-as-string": true }, "Catalog": { "$ref": "#/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 } } } ] }, "software.HyperflexDistributable.List": { "title": "List of 'software.HyperflexDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.HyperflexDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.HyperflexDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.HyperflexDistributable" }, "nullable": true } } } ] }, "software.IksBundleDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.IksBundleDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.IksBundleDistributable' resources.", "x-one-of-name": "software.IksBundleDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.IksBundleDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.IksBundleDistributable": { "title": "IKS Bundle", "description": "An IKS image bundle distributed by Cisco for Private Appliance.", "x-allOf-name": "software.IksBundleDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.IksBundleDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.IksBundleDistributable" ], "default": "software.IksBundleDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.IksBundleDistributable" ], "default": "software.IksBundleDistributable", "x-enum-as-string": true }, "Catalog": { "$ref": "#/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 }, "Images": { "description": "An array of relationships to softwareSolutionDistributable resources.", "type": "array", "items": { "$ref": "#/components/schemas/software.SolutionDistributable.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "software.IksBundleDistributable.List": { "title": "List of 'software.IksBundleDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.IksBundleDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.IksBundleDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.IksBundleDistributable" }, "nullable": true } } } ] }, "software.ReleaseMeta.Response": { "description": "The response body of a HTTP GET request for the 'software.ReleaseMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.ReleaseMeta' resources.", "x-one-of-name": "software.ReleaseMeta.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.ReleaseMeta.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.ReleaseMeta": { "title": "Software Release Information", "description": "Release information for various software images. Gives information on the latest released version of a product.", "x-allOf-name": "software.ReleaseMeta", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.ReleaseMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.ReleaseMeta" ], "default": "software.ReleaseMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.ReleaseMeta" ], "default": "software.ReleaseMeta", "x-enum-as-string": true }, "ImageType": { "description": "The subtype of the distributable image. For e.g. the firmware distributable is categorized according to the component it can upgrade - Standalone server, Intersight managed server or UCS Managed Fabric Interconnect.", "type": "string", "x-omitempty": true }, "LatestFileName": { "description": "The name of the latest image file uploaded for this software type. It is populated as part of the image import operation.", "type": "string", "x-omitempty": true }, "LatestVersion": { "description": "Latest version of the image avaiable for a specific software.", "type": "string", "readOnly": true, "x-omitempty": true }, "SoftwareTypeId": { "description": "The software type id of the image (For e.g. firmware.Distributable, software.ApplianceDistributable, software.HyperflexBundleDistributable, software.UcsdBundleDistributable).", "type": "string", "x-omitempty": true }, "Catalog": { "$ref": "#/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 }, "Image": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable.Relationship", "description": "A reference to a firmwareBaseDistributable resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "software.ReleaseMeta.List": { "title": "List of 'software.ReleaseMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.ReleaseMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.ReleaseMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.ReleaseMeta" }, "nullable": true } } } ] }, "software.SolutionDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.SolutionDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.SolutionDistributable' resources.", "x-one-of-name": "software.SolutionDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.SolutionDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.SolutionDistributable.Relationship": { "description": "A relationship to the 'software.SolutionDistributable' resource, or the expanded 'software.SolutionDistributable' resource, or the 'null' value.", "x-one-of-name": "software.SolutionDistributable.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/software.SolutionDistributable" } ], "discriminator": { "propertyName": "ClassId" } }, "software.SolutionDistributable": { "title": "Solution distributable image", "description": "The SolutionDistributable object represents a solution image distributed by Cisco. It is a key component in deploying and upgrading solution-specific images within the system.\n#### Purpose\nSolutionDistributable serves as the repository for solution-specific images, supporting deployment and upgrade processes within solution environments.\n#### Key Concepts\n- **Solution Management:** Provides solution-specific images for deployment and upgrades, ensuring compatibility.\n- **Catalog Integration:** Links solution images with the Intersight catalog for comprehensive management.\n- **Compatibility Assurance:** Ensures that solution images are compatible with system components.\n- **Administrative Tools:** Offers tools for managing solution-specific image distributions.", "x-allOf-name": "software.SolutionDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.SolutionDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.SolutionDistributable" ], "default": "software.SolutionDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.SolutionDistributable" ], "default": "software.SolutionDistributable", "x-enum-as-string": true }, "FilePath": { "description": "The path of the file in S3/minio bucket.", "type": "string", "readOnly": true, "x-omitempty": true }, "SolutionName": { "description": "The name of the solution in which the image belongs.", "type": "string", "x-omitempty": true }, "SubType": { "description": "The type of the file like OS image, Script etc.\n* `osimage` - The solution OS image for deployment.\n* `script` - The Python script for the solution VM configuration and deployment.", "type": "string", "enum": [ "osimage", "script" ], "default": "osimage", "x-omitempty": true }, "Catalog": { "$ref": "#/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 } } } ] }, "software.SolutionDistributable.List": { "title": "List of 'software.SolutionDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.SolutionDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.SolutionDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.SolutionDistributable" }, "nullable": true } } } ] }, "software.UcsdBundleDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.UcsdBundleDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.UcsdBundleDistributable' resources.", "x-one-of-name": "software.UcsdBundleDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.UcsdBundleDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.UcsdBundleDistributable": { "title": "UCS Director Bundle", "description": "A UCSD connector pack image bundle distributed by Cisco for Private Appliance.", "x-allOf-name": "software.UcsdBundleDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.UcsdBundleDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.UcsdBundleDistributable" ], "default": "software.UcsdBundleDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "software.UcsdBundleDistributable" ], "default": "software.UcsdBundleDistributable", "x-enum-as-string": true }, "Catalog": { "$ref": "#/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 }, "Images": { "description": "An array of relationships to softwareUcsdDistributable resources.", "type": "array", "items": { "$ref": "#/components/schemas/software.UcsdDistributable.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "software.UcsdBundleDistributable.List": { "title": "List of 'software.UcsdBundleDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.UcsdBundleDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.UcsdBundleDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.UcsdBundleDistributable" }, "nullable": true } } } ] }, "software.UcsdDistributable.Response": { "description": "The response body of a HTTP GET request for the 'software.UcsdDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'software.UcsdDistributable' resources.", "x-one-of-name": "software.UcsdDistributable.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/software.UcsdDistributable.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "software.UcsdDistributable.Relationship": { "description": "A relationship to the 'software.UcsdDistributable' resource, or the expanded 'software.UcsdDistributable' resource, or the 'null' value.", "x-one-of-name": "software.UcsdDistributable.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/software.UcsdDistributable" } ], "discriminator": { "propertyName": "ClassId" } }, "software.UcsdDistributable": { "title": "UCS Director", "description": "A UCSD connector pack image distributed by Cisco.", "x-allOf-name": "software.UcsdDistributable", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'software.UcsdDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "software.UcsdDistributable" ], "default": "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.", "enum": [ "software.UcsdDistributable" ], "default": "software.UcsdDistributable", "x-enum-as-string": true }, "Catalog": { "$ref": "#/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 } } } ] }, "software.UcsdDistributable.List": { "title": "List of 'software.UcsdDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'software.UcsdDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'software.UcsdDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/software.UcsdDistributable" }, "nullable": true } } } ] }, "softwarerepository.ApplianceUpload": { "title": "Appliance Upload", "description": "The user's local machine is being used as the source of an image. This upload operation is for an airgapped appliance.", "x-allOf-name": "softwarerepository.ApplianceUpload", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.FileServer" } ] }, "softwarerepository.Authorization.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.Authorization' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.Authorization' resources.", "x-one-of-name": "softwarerepository.Authorization.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.Authorization.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.Authorization": { "title": "Softwarerepository:Authorization", "description": "User's consent for Intersight to contact an external software repository such as cisco.com, on the behalf of the user.", "x-allOf-name": "softwarerepository.Authorization", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.Authorization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.Authorization" ], "default": "softwarerepository.Authorization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.Authorization" ], "default": "softwarerepository.Authorization", "x-enum-as-string": true }, "IsAsdv4AlarmDismissed": { "description": "The state of the alarm dismissal for the 'IsAsdDialogDismissed' alarm.", "type": "boolean", "readOnly": true, "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": "The password that will be used by Intersight to create OAuth2 tokens for interacting with the external repository, on the user account's behalf.", "type": "string", "writeOnly": true, "x-omitempty": true }, "RepositoryType": { "description": "The external repository for which this authorization has been provided. The only supported repository today is cisco.com.\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 }, "UserId": { "description": "The username that will be used by Intersight to create OAuth2 tokens for interacting with the external repository, on the user account's behalf.", "type": "string", "x-omitempty": true }, "Version": { "description": "The Automated Software Distribution version of the authorization MO.\n* `V3` - The client is running Automated Software Distribution V3.\n* `V4` - The client is running Automated Software Distribution V4.", "type": "string", "enum": [ "V3", "V4" ], "default": "V3", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "softwarerepository.Authorization.List": { "title": "List of 'softwarerepository.Authorization' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.Authorization' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.Authorization' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.Authorization" }, "nullable": true } } } ] }, "softwarerepository.BaseDistributable": { "title": "Softwarerepository:Base Distributable", "description": "An image distributed by Cisco.", "x-allOf-name": "softwarerepository.BaseDistributable", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.File" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.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": [ "softwarerepository.OperatingSystemFile" ], "default": "softwarerepository.OperatingSystemFile", "x-enum-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": [ "softwarerepository.OperatingSystemFile" ], "default": "softwarerepository.OperatingSystemFile", "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 }, "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, Unified Edge server. 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 }, "Release": { "$ref": "#/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." } } } ] }, "softwarerepository.CachedImage.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.CachedImage' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.CachedImage' resources.", "x-one-of-name": "softwarerepository.CachedImage.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.CachedImage.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.CachedImage": { "title": "Softwarerepository:Cached Image", "description": "The image cached in the customer's datacenter.", "x-allOf-name": "softwarerepository.CachedImage", "allOf": [ { "$ref": "#/components/schemas/connector.DownloadStatus" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.CachedImage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.CachedImage" ], "default": "softwarerepository.CachedImage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.CachedImage" ], "default": "softwarerepository.CachedImage", "x-enum-as-string": true }, "Action": { "description": "The action to be performed on the imported file. If 'PreCache' is set, the image will be cached in endpoint. If 'Evict' is set, the cached file will be removed. Applicable in Intersight appliance deployment. If 'Cancel' is set, the ImportState is marked as 'Failed'. Applicable for local machine source.\n* `None` - No action should be taken on the imported file.\n* `GeneratePreSignedUploadUrl` - Generate pre signed URL of file for importing into the repository.\n* `GeneratePreSignedDownloadUrl` - Generate pre signed URL of file in the repository to download.\n* `CompleteImportProcess` - Mark that the import process of the file into the repository is complete.\n* `MarkImportFailed` - Mark to indicate that the import process of the file into the repository failed.\n* `PreCache` - Cache the file into the Intersight Appliance.\n* `Cancel` - The cancel import process for the file into the repository.\n* `Extract` - The action to extract the file in the external repository.\n* `Evict` - Evict the cached file from the Intersight Appliance.", "type": "string", "enum": [ "None", "GeneratePreSignedUploadUrl", "GeneratePreSignedDownloadUrl", "CompleteImportProcess", "MarkImportFailed", "PreCache", "Cancel", "Extract", "Evict" ], "default": "None", "x-omitempty": true }, "CacheState": { "description": "The state of this file in the endpoint The importState is updated during the cache operation and as part of the cache monitoring process.\n* `ReadyForImport` - The image is ready to be imported into the repository.\n* `Importing` - The image is being imported into the repository.\n* `Imported` - The image has been extracted and imported into the repository.\n* `ComputingMetadata` - Indicates that the image has been imported but its metadata computation has not been done.\n* `PendingExtraction` - Indicates that the image has been imported but not extracted in the repository.\n* `Extracting` - Indicates that the image is being extracted into the repository.\n* `Extracted` - Indicates that the image has been extracted into the repository.\n* `Failed` - The image import from an external source to the repository has failed.\n* `MetaOnly` - The image is present in an external repository.\n* `ReadyForCache` - The image is ready to be cached into the Intersight Appliance.\n* `Caching` - Indicates that the image is being cached into the Intersight Appliance or endpoint cache.\n* `Cached` - Indicates that the image has been cached into the Intersight Appliance or endpoint cache.\n* `CachingFailed` - Indicates that the image caching into the Intersight Appliance failed or endpoint cache.\n* `Corrupted` - Indicates that the image in the local repository (or endpoint cache) has been corrupted after it was cached.\n* `Evicted` - Indicates that the image has been evicted from the Intersight Appliance (or endpoint cache) to reclaim storage space.\n* `Invalid` - Indicates that the corresponding distributable MO has been removed from the backend. This can be due to unpublishing of an image.", "type": "string", "enum": [ "ReadyForImport", "Importing", "Imported", "ComputingMetadata", "PendingExtraction", "Extracting", "Extracted", "Failed", "MetaOnly", "ReadyForCache", "Caching", "Cached", "CachingFailed", "Corrupted", "Evicted", "Invalid" ], "default": "ReadyForImport", "readOnly": true, "x-omitempty": true }, "CachedTime": { "description": "The time when the image or file was cached into the FI storage.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastAccessTime": { "description": "Used by the cache monitoring process to determine the files that are to be evicted from the cache.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Md5sum": { "description": "The MD5 sum of the firmware image that will be used by the endpoint to validate the integrity of the image.", "type": "string", "readOnly": true, "x-omitempty": true }, "OriginalSha512sum": { "description": "The actual sha512sum of the cached image.", "type": "string", "readOnly": true, "x-omitempty": true }, "Path": { "description": "The absolute path of the imported file in the endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredWorkflows": { "type": "array", "items": { "description": "A collection of workflows currently used by the cached image.", "type": "string", "x-omitempty": true }, "nullable": true }, "UsedCount": { "description": "The number of times this file has been used to copy or upgrade or install actions. Used by the cache monitoring process to determine the files to be evicted from the cache.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "File": { "$ref": "#/components/schemas/softwarerepository.File.Relationship", "description": "A reference to a softwarerepositoryFile 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 } } } ] }, "softwarerepository.CachedImage.List": { "title": "List of 'softwarerepository.CachedImage' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.CachedImage' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.CachedImage' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.CachedImage" }, "nullable": true } } } ] }, "softwarerepository.Catalog.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.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 'softwarerepository.Catalog' resources.", "x-one-of-name": "softwarerepository.Catalog.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.Catalog.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.Catalog.Relationship": { "description": "A relationship to the 'softwarerepository.Catalog' resource, or the expanded 'softwarerepository.Catalog' resource, or the 'null' value.", "x-one-of-name": "softwarerepository.Catalog.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/softwarerepository.Catalog" } ], "discriminator": { "propertyName": "ClassId" } }, "softwarerepository.Catalog": { "title": "Softwarerepository:Catalog", "description": "A container MO that holds references to the files in an account's image repository. It is internally created for each account and is used to hold information about all user uploaded files.", "x-allOf-name": "softwarerepository.Catalog", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.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": [ "softwarerepository.Catalog" ], "default": "softwarerepository.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": [ "softwarerepository.Catalog" ], "default": "softwarerepository.Catalog", "x-enum-as-string": true }, "IsImagePullFailure": { "description": "The status of the image catalog synchronization operation.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the catalog. The names are populated and predefined during MO creation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/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.", "readOnly": true }, "System": { "$ref": "#/components/schemas/iam.System.Relationship", "description": "A reference to a iamSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "softwarerepository.Catalog.List": { "title": "List of 'softwarerepository.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.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 'softwarerepository.Catalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.Catalog" }, "nullable": true } } } ] }, "softwarerepository.CategoryMapper.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.CategoryMapper' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.CategoryMapper' resources.", "x-one-of-name": "softwarerepository.CategoryMapper.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.CategoryMapper.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.CategoryMapper": { "title": "Softwarerepository:Category Mapper", "description": "The CategoryMapper object serves as a mapping tool to associate Cisco software repository image categories with applicable hardware models. This ensures compatibility and supports efficient software deployment.\n#### Purpose\nCategoryMapper is used to identify compatible hardware models for specific software categories, aiding in software deployment and upgrade processes.\n#### Key Concepts\n- **Mapping:** Establishes connections between software categories and hardware models, ensuring compatibility.\n- **Software Deployment:** Facilitates the identification of suitable hardware for software installations and updates.\n- **Administration:** Provides administrative capabilities to create, update, and manage mappings.\n- **Catalog Integration:** Links software categories to hardware models within the Intersight catalog.", "x-allOf-name": "softwarerepository.CategoryMapper", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.CategoryMapper', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.CategoryMapper" ], "default": "softwarerepository.CategoryMapper", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.CategoryMapper" ], "default": "softwarerepository.CategoryMapper", "x-enum-as-string": true }, "Category": { "description": "The category of the model series.", "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 }, "ImageType": { "description": "The type of image based on the endpoint it can upgrade. For example, ucs-c420m5-huu-3.2.1a.iso can upgrade standalone servers, so the image type is Standalone Server.", "type": "string", "x-omitempty": true }, "IsNfsUpgradeSupported": { "description": "Defines whether NFS firmware upgrade is supported with this image type.", "type": "boolean", "x-omitempty": true }, "MdfId": { "description": "Cisco software repository image category identifier.", "type": "string", "x-omitempty": true }, "RegexPattern": { "description": "The regex that all images of this category follow.", "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": "List of hardware models on which this software can run.", "type": "string", "x-omitempty": true }, "nullable": true }, "SwId": { "description": "The software type id provided by cisco.com.", "type": "string", "x-omitempty": true }, "TagTypes": { "type": "array", "items": { "description": "The tag type of image, example, if image is published to cloud, tag is IntersightCloud. If image is from Cisco repository, tag type is Cisco.", "type": "string", "x-omitempty": true }, "nullable": true }, "Version": { "description": "The version from which user can download images from amazon store, if source is external cloud store.", "type": "string", "x-omitempty": true } } } ] }, "softwarerepository.CategoryMapper.List": { "title": "List of 'softwarerepository.CategoryMapper' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.CategoryMapper' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.CategoryMapper' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.CategoryMapper" }, "nullable": true } } } ] }, "softwarerepository.CategoryMapperModel.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.CategoryMapperModel' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.CategoryMapperModel' resources.", "x-one-of-name": "softwarerepository.CategoryMapperModel.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.CategoryMapperModel.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.CategoryMapperModel": { "title": "Softwarerepository:Category Mapper Model", "description": "The CategoryMapperModel object maps Cisco hardware model series to their applicable hardware models. It is a critical component in defining hardware compatibility for software deployment.\n#### Purpose\nCategoryMapperModel assists in identifying the relationship between hardware series and models, supporting hardware-specific software deployments.\n#### Key Concepts\n- **Series Mapping:** Connects hardware model series with specific models to define software compatibility.\n- **Deployment Support:** Ensures software is deployed on compatible hardware models, streamlining upgrade processes.\n- **Administrative Control:** Offers tools for managing and updating model-series mappings.\n- **Catalog Integration:** Integrates with the Intersight catalog for comprehensive mapping and compatibility checks.", "x-allOf-name": "softwarerepository.CategoryMapperModel", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.CategoryMapperModel', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.CategoryMapperModel" ], "default": "softwarerepository.CategoryMapperModel", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.CategoryMapperModel" ], "default": "softwarerepository.CategoryMapperModel", "x-enum-as-string": true }, "Category": { "description": "The category of the model series.", "type": "string", "x-omitempty": true }, "DistTag": { "description": "The distributable tag value of the model series.", "type": "string", "x-omitempty": true }, "ImageType": { "description": "The type of image based on the endpoint it can upgrade. For example, ucs-bundle-6400-infra.4.1.2a.bin can upgrade ucs managed fabric interconnects, so the image type is UCS Managed Fabric Interconnect.", "type": "string", "x-omitempty": true }, "IsNfsUpgradeSupported": { "description": "Defines whether NFS firmware upgrade is supported with this image type.", "type": "boolean", "x-omitempty": true }, "RegexPattern": { "description": "The regex that all images of this model follow.", "type": "string", "x-omitempty": true }, "SeriesId": { "description": "Cisco hardware model series.", "type": "string", "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of hardware models that belongs to the seriesID.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "softwarerepository.CategoryMapperModel.List": { "title": "List of 'softwarerepository.CategoryMapperModel' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.CategoryMapperModel' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.CategoryMapperModel' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.CategoryMapperModel" }, "nullable": true } } } ] }, "softwarerepository.CategorySupportConstraint.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.CategorySupportConstraint' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.CategorySupportConstraint' resources.", "x-one-of-name": "softwarerepository.CategorySupportConstraint.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.CategorySupportConstraint.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.CategorySupportConstraint": { "title": "Softwarerepository:Category Support Constraint", "description": "The CategorySupportConstraint object defines constraints for models supported from certain minimum image versions. It plays a vital role in managing software compatibility and upgrade paths.\n#### Purpose\nCategorySupportConstraint ensures that only supported hardware models receive updates or installations, safeguarding against compatibility issues.\n#### Key Concepts\n- **Version Constraints:** Specifies minimum image versions required for model support, preventing incompatibility.\n- **Management:** Helps manage software installation and upgrade processes according to defined constraints.\n- **Compatibility Assurance:** Protects systems by ensuring only compatible models receive updates.\n- **Integration:** Works seamlessly with the Intersight catalog for hardware model verification.", "x-allOf-name": "softwarerepository.CategorySupportConstraint", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.CategorySupportConstraint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.CategorySupportConstraint" ], "default": "softwarerepository.CategorySupportConstraint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.CategorySupportConstraint" ], "default": "softwarerepository.CategorySupportConstraint", "x-enum-as-string": true }, "ConstraintId": { "description": "Identifier for this managed object.", "type": "string", "x-omitempty": true }, "FilteredModels": { "type": "array", "items": { "description": "List of all the version constraints based on image name and model.", "$ref": "#/components/schemas/softwarerepository.ConstraintModels", "x-omitempty": true }, "nullable": true }, "MdfId": { "description": "Cisco software repository image category identifier.", "type": "string", "x-omitempty": true }, "MinVersion": { "description": "Minimum image version from where the models can be supported.", "type": "string", "x-omitempty": true }, "ParseFromImageName": { "description": "Fields which tells if the constraint is based on image name parsing.", "type": "boolean", "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of hardware models which are supported.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "softwarerepository.CategorySupportConstraint.List": { "title": "List of 'softwarerepository.CategorySupportConstraint' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.CategorySupportConstraint' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.CategorySupportConstraint' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.CategorySupportConstraint" }, "nullable": true } } } ] }, "softwarerepository.CategoryUnsupportedModels.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.CategoryUnsupportedModels' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.CategoryUnsupportedModels' resources.", "x-one-of-name": "softwarerepository.CategoryUnsupportedModels.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.CategoryUnsupportedModels.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.CategoryUnsupportedModels": { "title": "Softwarerepository:Category Unsupported Models", "description": "The CategoryUnsupportedModels object defines constraints for models that become unsupported after specific infra versions. It is crucial for managing software deployment and avoiding unsupported configurations.\n#### Purpose\nCategoryUnsupportedModels helps identify models that are no longer supported for updates after certain versions, aiding in the management of software upgrades.\n#### Key Concepts\n- **Unsupported Constraints:** Lists models that become unsupported after specific software versions, preventing upgrade errors.\n- **Software Deployment:** Guides software installation processes by identifying unsupported configurations.\n- **Safety Measures:** Ensures that only supported models are considered for updates, reducing risk.\n- **Catalog Integration:** Utilizes the Intersight catalog for model verification and support checks.", "x-allOf-name": "softwarerepository.CategoryUnsupportedModels", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.CategoryUnsupportedModels', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.CategoryUnsupportedModels" ], "default": "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.", "enum": [ "softwarerepository.CategoryUnsupportedModels" ], "default": "softwarerepository.CategoryUnsupportedModels", "x-enum-as-string": true }, "MdfId": { "description": "Cisco software repository image category identifier.", "type": "string", "x-omitempty": true }, "ModelConstraint": { "type": "array", "items": { "description": "Unsupported server model constraint.", "$ref": "#/components/schemas/softwarerepository.UnsupportedModelConstraint", "x-omitempty": true }, "nullable": true } } } ] }, "softwarerepository.CategoryUnsupportedModels.List": { "title": "List of 'softwarerepository.CategoryUnsupportedModels' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.CategoryUnsupportedModels' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.CategoryUnsupportedModels' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.CategoryUnsupportedModels" }, "nullable": true } } } ] }, "softwarerepository.CifsServer": { "title": "CIFS", "description": "An external file repository accessible through the CIFS protocol.", "x-allOf-name": "softwarerepository.CifsServer", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.FileServer" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.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": [ "softwarerepository.CifsServer" ], "default": "softwarerepository.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": [ "softwarerepository.CifsServer" ], "default": "softwarerepository.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 }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "MountOption": { "description": "For CIFS, leave the field blank or enter one or more comma seperated options from the following. For Example, \" \" , \" soft \" , \" soft , nounix \" .\n* soft.\n* nounix.\n* noserviceino.\n* guest.\n* USERNAME=VALUE.\n* PASSWORD=VALUE.\n* sec=VALUE (VALUE could be None, Ntlm, Ntlmi, Ntlmssp, Ntlmsspi, Ntlmv2, Ntlmv2i).", "type": "string", "x-omitempty": true }, "Password": { "description": "Password configured on the CIFS server.", "type": "string", "writeOnly": true, "x-omitempty": true }, "RemoteFile": { "description": "Filename of the image in the CIFS server. For example:ucs-c220m5-huu-3.1.2c.iso.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteIp": { "description": "Hostname or IP Address of the CIFS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteShare": { "description": "Remote directory where the image is present. For example:/share/subfolder.", "type": "string", "readOnly": true, "x-omitempty": true }, "Username": { "description": "Username configured on the CIFS server.", "type": "string", "x-omitempty": true } } } ] }, "softwarerepository.ConstraintModels": { "title": "Softwarerepository:Constraint Models", "description": "It defines a contraint that given an image name regex and version, only certain models are supported for firmware upgrades.", "x-allOf-name": "softwarerepository.ConstraintModels", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.ConstraintModels', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.ConstraintModels" ], "default": "softwarerepository.ConstraintModels", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.ConstraintModels" ], "default": "softwarerepository.ConstraintModels", "x-enum-as-string": true }, "MinVersion": { "description": "Minimum version of the image.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the contraint, used to identify constriant type.", "type": "string", "x-omitempty": true }, "PlatformRegex": { "description": "Regular expression of the image name.", "type": "string", "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "Supported models for the image.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "softwarerepository.DownloadSpec.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.DownloadSpec' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.DownloadSpec' resources.", "x-one-of-name": "softwarerepository.DownloadSpec.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.DownloadSpec.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.DownloadSpec": { "title": "Softwarerepository:Download Spec", "description": "The URL, certificate and other associated information required to download an image listed in an Intersight catalog.", "x-allOf-name": "softwarerepository.DownloadSpec", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.DownloadSpec', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.DownloadSpec" ], "default": "softwarerepository.DownloadSpec", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.DownloadSpec" ], "default": "softwarerepository.DownloadSpec", "x-enum-as-string": true }, "AuthToken": { "description": "The OAuth2 token that will be used during image download by the endpoint to authenticate with file server.", "type": "string", "x-omitempty": true }, "CdnDisabled": { "description": "A boolean flag which indicates that the generated pre-signed url is not a CDN URL. An URL to Intersight storage source will be returned with the old domain name. This flag should be used when the pre-signed CDN URL is not accessible from endpoint/appliance.", "type": "boolean", "x-omitempty": true }, "Certificate": { "description": "The certificate of file server that will be used by the endpoint to validate the server before starting the file download.", "type": "string", "x-omitempty": true }, "Filename": { "description": "The name of the firmware image.", "type": "string", "x-omitempty": true }, "Md5sum": { "description": "MD5 sum of the firmware image that will be used by the endpoint to validate the integrity of the image, post download.", "type": "string", "x-omitempty": true }, "Size": { "description": "The size (in bytes) of the firmware image.", "type": "integer", "format": "int64", "x-omitempty": true }, "Url": { "description": "The URL of this file in file server. The endpoint uses this URL to download the file from the file server.", "type": "string", "x-omitempty": true }, "File": { "$ref": "#/components/schemas/softwarerepository.File.Relationship", "description": "A reference to a softwarerepositoryFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "softwarerepository.DownloadSpec.List": { "title": "List of 'softwarerepository.DownloadSpec' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.DownloadSpec' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.DownloadSpec' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.DownloadSpec" }, "nullable": true } } } ] }, "softwarerepository.File.Relationship": { "description": "A relationship to the 'softwarerepository.File' resource, or the expanded 'softwarerepository.File' resource, or the 'null' value.", "x-one-of-name": "softwarerepository.File.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/softwarerepository.File" } ], "discriminator": { "propertyName": "ClassId" } }, "softwarerepository.File": { "title": "Softwarerepository:File", "description": "A file that resides either in an external repository or has been imported to the local repository. If the file is available in the local repository, it is marked as cached. If not, it represents a pointer to a file in an external repository. Instances of this MO will be implicitly created as part of the file import operation.", "x-allOf-name": "softwarerepository.File", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.File', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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", "mgmt.ConfigBackupFile", "openapi.OpenApiSpecification", "partnerintegration.File", "software.ApplianceDistributable", "software.HciBundleDistributable", "software.HciDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.IksBundleDistributable", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable", "softwarerepository.OperatingSystemFile" ], "x-enum-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", "mgmt.ConfigBackupFile", "openapi.OpenApiSpecification", "partnerintegration.File", "software.ApplianceDistributable", "software.HciBundleDistributable", "software.HciDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.IksBundleDistributable", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable", "softwarerepository.OperatingSystemFile" ], "x-enum-as-string": true }, "Description": { "description": "User provided description about the file. Cisco provided description for image inventoried from a Cisco repository.", "type": "string", "x-omitempty": true }, "DownloadCount": { "description": "The number of times this file has been downloaded from the local repository. It is used by the repository monitoring process to determine the files that are to be evicted from the cache.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FeatureSource": { "description": "The name of the feature to which the uploaded file belongs.\n* `System` - This indicates system initiated file uploads.\n* `OpenAPIImport` - This indicates an OpenAPI file upload.\n* `ConfigBackupImport` - This indicates the user uploaded configuration backup file.\n* `PartnerIntegrationImport` - This indicates a Partner-Integration Appliance user file uploads.", "type": "string", "enum": [ "System", "OpenAPIImport", "ConfigBackupImport", "PartnerIntegrationImport" ], "default": "System", "readOnly": true, "x-omitempty": true }, "ImportAction": { "description": "The action to be performed on the imported file. If 'PreCache' is set, the image will be cached in Appliance. Applicable in Intersight appliance deployment. If 'Evict' is set, the cached file will be removed. Applicable in Intersight appliance deployment. If 'GeneratePreSignedUploadUrl' is set, generates pre signed URL (s) for the file to be imported into the repository. Applicable for local machine source. The URL (s) will be populated under LocalMachine file server. If 'CompleteImportProcess' is set, the ImportState is marked as 'Imported'. Applicable for local machine source. If 'Cancel' is set, the ImportState is marked as 'Failed'. Applicable for local machine source.\n* `None` - No action should be taken on the imported file.\n* `GeneratePreSignedUploadUrl` - Generate pre signed URL of file for importing into the repository.\n* `GeneratePreSignedDownloadUrl` - Generate pre signed URL of file in the repository to download.\n* `CompleteImportProcess` - Mark that the import process of the file into the repository is complete.\n* `MarkImportFailed` - Mark to indicate that the import process of the file into the repository failed.\n* `PreCache` - Cache the file into the Intersight Appliance.\n* `Cancel` - The cancel import process for the file into the repository.\n* `Extract` - The action to extract the file in the external repository.\n* `Evict` - Evict the cached file from the Intersight Appliance.", "type": "string", "enum": [ "None", "GeneratePreSignedUploadUrl", "GeneratePreSignedDownloadUrl", "CompleteImportProcess", "MarkImportFailed", "PreCache", "Cancel", "Extract", "Evict" ], "default": "None", "x-omitempty": true }, "ImportState": { "description": "The state of this file in the repository or Appliance. The importState is updated during the import operation and as part of the repository monitoring process.\n* `ReadyForImport` - The image is ready to be imported into the repository.\n* `Importing` - The image is being imported into the repository.\n* `Imported` - The image has been extracted and imported into the repository.\n* `ComputingMetadata` - Indicates that the image has been imported but its metadata computation has not been done.\n* `PendingExtraction` - Indicates that the image has been imported but not extracted in the repository.\n* `Extracting` - Indicates that the image is being extracted into the repository.\n* `Extracted` - Indicates that the image has been extracted into the repository.\n* `Failed` - The image import from an external source to the repository has failed.\n* `MetaOnly` - The image is present in an external repository.\n* `ReadyForCache` - The image is ready to be cached into the Intersight Appliance.\n* `Caching` - Indicates that the image is being cached into the Intersight Appliance or endpoint cache.\n* `Cached` - Indicates that the image has been cached into the Intersight Appliance or endpoint cache.\n* `CachingFailed` - Indicates that the image caching into the Intersight Appliance failed or endpoint cache.\n* `Corrupted` - Indicates that the image in the local repository (or endpoint cache) has been corrupted after it was cached.\n* `Evicted` - Indicates that the image has been evicted from the Intersight Appliance (or endpoint cache) to reclaim storage space.\n* `Invalid` - Indicates that the corresponding distributable MO has been removed from the backend. This can be due to unpublishing of an image.", "type": "string", "enum": [ "ReadyForImport", "Importing", "Imported", "ComputingMetadata", "PendingExtraction", "Extracting", "Extracted", "Failed", "MetaOnly", "ReadyForCache", "Caching", "Cached", "CachingFailed", "Corrupted", "Evicted", "Invalid" ], "default": "ReadyForImport", "readOnly": true, "x-omitempty": true }, "ImportedTime": { "description": "The time at which this image or file was imported/cached into the repositry. if the 'ImportState' is 'Imported', the time at which this image or file was imported. if the 'ImportState' is 'Cached', the time at which this image or file was cached.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastAccessTime": { "description": "The time at which this file was last downloaded from the local repository. It is used by the repository monitoring process to determine the files that are to be evicted from the cache.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Md5eTag": { "description": "The MD5 ETag for a file that is stored in Intersight repository or in the appliance cache. Warning - MD5 is currently broken and this will be migrated to SHA shortly.", "type": "string", "x-omitempty": true }, "Md5sum": { "description": "The md5sum checksum of the file. This information is available for all Cisco distributed images and files imported to the local repository.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the file. It is populated as part of the image import operation.", "type": "string", "maxLength": 128, "x-omitempty": true }, "ReleaseDate": { "description": "The date on which the file was released or distributed by its vendor.", "type": "string", "format": "date-time", "x-omitempty": true }, "Sha512sum": { "description": "The sha512sum of the file. This information is available for all Cisco distributed images and files imported to the local repository.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Size": { "description": "The size (in bytes) of the file. This information is available for all Cisco distributed images and files imported to the local repository.", "type": "integer", "format": "int64", "x-omitempty": true }, "SoftwareAdvisoryUrl": { "description": "The software advisory, if any, provided by the vendor for this file.", "type": "string", "x-omitempty": true }, "Source": { "description": "Location of the file in an external repository.", "$ref": "#/components/schemas/softwarerepository.FileServer", "x-omitempty": true }, "Version": { "description": "Vendor provided version for the file.", "type": "string", "x-omitempty": true } } } ] }, "softwarerepository.FileServer": { "title": "Softwarerepository:File Server", "description": "An external software repository which serves as the source of the file to be imported into the image catalog. If the source is available in the user's local machine, needs to be corrected to source image or just image If not, only a pointer to the file in the external repository is created in the image catalog.\nFor more information, please refer to the softwarerepositoryUploader and softwarerepositoryFile object descriptions where this type is used.", "x-allOf-name": "softwarerepository.FileServer", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" } ] }, "softwarerepository.HttpServer": { "title": "HTTP/S", "description": "An external HTTP file server. This can represent the cisco.com website or a HTTP server in the user's datacenter.", "x-allOf-name": "softwarerepository.HttpServer", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.FileServer" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.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": [ "softwarerepository.HttpServer" ], "default": "softwarerepository.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": [ "softwarerepository.HttpServer" ], "default": "softwarerepository.HttpServer", "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 }, "LocationLink": { "description": "HTTP/HTTPS link to the image. Accepted formats are HTTP[s]://server-hostname/share/image or HTTP[s]://serverip/share/image.", "type": "string", "x-omitempty": true }, "Password": { "description": "Password as configured on the HTTP[S] server for user authentication. It is generally required to authenticate user provided HTTP[S] based software repositories.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Username": { "description": "Username as configured on the HTTP[S] server for user authentication. It is generally required to authenticate user provided HTTP[S] based software repositories.", "type": "string", "x-omitempty": true } } } ] }, "softwarerepository.ImportResult": { "title": "Softwarerepository:Import Result", "description": "The status of the import operation.", "x-allOf-name": "softwarerepository.ImportResult", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.ImportResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.ImportResult" ], "default": "softwarerepository.ImportResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.ImportResult" ], "default": "softwarerepository.ImportResult", "x-enum-as-string": true }, "ErrorMessage": { "description": "The reason for the failure of an import operation, if applicable.", "type": "string", "readOnly": true, "x-omitempty": true }, "Progress": { "description": "The progress percentage for the import operation.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "softwarerepository.LocalMachine": { "title": "Local Machine", "description": "The user's local machine that is being used as the source for an image.", "x-allOf-name": "softwarerepository.LocalMachine", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.FileServer" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.LocalMachine', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.LocalMachine" ], "default": "softwarerepository.LocalMachine", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.LocalMachine" ], "default": "softwarerepository.LocalMachine", "x-enum-as-string": true }, "DownloadUrl": { "description": "When the import action in the file MO is updated with 'GeneratePreSignedDownloadUrl', Intersight returns a pre-signed URL in this property as part of the patch response. The user is expected to subsequently download the file using this URL.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartSize": { "description": "The chunk size (in bytes) for each part of the file to be uploaded.", "type": "integer", "format": "int64", "x-omitempty": true }, "UploadId": { "description": "When the import action in file MO is updated with 'GeneratePreSignedUploadUrl', Intersight shall return a upload Id in this property as part of the PATCH response.", "type": "string", "x-omitempty": true }, "UploadUrl": { "description": "When a file MO is created with 'LocalMachine' as the source, Intersight returns a pre-signed URL in this property as part of the POST response. The user is expected to subsequently upload the file content using this URL. Once the upload is completed, the user is expected to patch the uploader object's transfer state to success.", "type": "string", "readOnly": true, "x-omitempty": true }, "UploadUrls": { "type": "array", "items": { "description": "When a file MO is created with 'LocalMachine' as the source, Intersight returns a list of pre-signed URLs in this property as part of the POST response. The user is expected to subsequently upload the file content in parts using these URLs. Once the uploads are complete, the user is expected to patch the uploader object's transfer state to success.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "softwarerepository.NfsServer": { "title": "NFS", "description": "An external file repository accessible through the NFS protocol.", "x-allOf-name": "softwarerepository.NfsServer", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.FileServer" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.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": [ "softwarerepository.NfsServer" ], "default": "softwarerepository.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": [ "softwarerepository.NfsServer" ], "default": "softwarerepository.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": "For NFS, leave the field blank or enter one or more comma seperated options from the following.For Example, \" \" , \" ro \" , \" ro , rw \" .\n* ro.\n* rw.\n* nolock.\n* noexec.\n* soft.\n* PORT=VALUE.\n* timeo=VALUE.\n* retry=VALUE.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteFile": { "description": "Filename of the image in the NFS server. For example:ucs-c220m5-huu-3.1.2c.iso.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteIp": { "description": "Hostname or IP Address of the NFS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteShare": { "description": "Remote directory where the image is present. For example:/share/subfolder.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "softwarerepository.OperatingSystemFile.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.OperatingSystemFile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.OperatingSystemFile' resources.", "x-one-of-name": "softwarerepository.OperatingSystemFile.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.OperatingSystemFile.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.OperatingSystemFile.Relationship": { "description": "A relationship to the 'softwarerepository.OperatingSystemFile' resource, or the expanded 'softwarerepository.OperatingSystemFile' resource, or the 'null' value.", "x-one-of-name": "softwarerepository.OperatingSystemFile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/softwarerepository.OperatingSystemFile" } ], "discriminator": { "propertyName": "ClassId" } }, "softwarerepository.OperatingSystemFile": { "title": "Operating System", "description": "The OperatingSystemFile object represents an operating system image that can reside in an external repository or be imported to a local repository. It supports efficient software deployment and upgrade processes.\n#### Purpose\nOperatingSystemFile serves as the repository for OS images, ensuring that systems can be updated and maintained with the latest operating system versions.\n#### Key Concepts\n- **OS Management:** Provides a structured approach to managing operating system images, supporting efficient upgrades.\n- **Deployment Support:** Facilitates software deployment through readily available OS images.\n- **Catalog Integration:** Works seamlessly with the Intersight catalog for comprehensive OS image management.\n- **Security:** Ensures image integrity and security through checksums and encryption.", "x-allOf-name": "softwarerepository.OperatingSystemFile", "allOf": [ { "$ref": "#/components/schemas/softwarerepository.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.OperatingSystemFile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.OperatingSystemFile" ], "default": "softwarerepository.OperatingSystemFile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.OperatingSystemFile" ], "default": "softwarerepository.OperatingSystemFile", "x-enum-as-string": true }, "FileName": { "description": "File name of the uploaded image.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ImportProgress": { "description": "The progress percentage for the import operation.", "type": "integer", "format": "int64", "x-omitempty": true }, "SampleHashes": { "description": "File sample hashes at deterministic positions for efficient duplicate detection of large files.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Vendor": { "description": "The vendor or publisher of this file.", "type": "string", "x-omitempty": true }, "Catalog": { "$ref": "#/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 } } } ] }, "softwarerepository.OperatingSystemFile.List": { "title": "List of 'softwarerepository.OperatingSystemFile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.OperatingSystemFile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.OperatingSystemFile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.OperatingSystemFile" }, "nullable": true } } } ] }, "softwarerepository.Release.Response": { "description": "The response body of a HTTP GET request for the 'softwarerepository.Release' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'softwarerepository.Release' resources.", "x-one-of-name": "softwarerepository.Release.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/softwarerepository.Release.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "softwarerepository.Release.Relationship": { "description": "A relationship to the 'softwarerepository.Release' resource, or the expanded 'softwarerepository.Release' resource, or the 'null' value.", "x-one-of-name": "softwarerepository.Release.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/softwarerepository.Release" } ], "discriminator": { "propertyName": "ClassId" } }, "softwarerepository.Release": { "title": "Softwarerepository:Release", "description": "A Cisco release containing one or more firmware images. Cisco releases images for rack server components or blade server components or for Fabric Interconnect components. The version for the firmware images is the same as specific Cisco release version.", "x-allOf-name": "softwarerepository.Release", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.Release', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.Release" ], "default": "softwarerepository.Release", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.Release" ], "default": "softwarerepository.Release", "x-enum-as-string": true }, "ReleaseDate": { "description": "The date when the file was released or distributed by its vendor.", "type": "string", "format": "date-time", "x-omitempty": true }, "ReleaseNotesUrl": { "description": "The URL for the release notes of this image.", "type": "string", "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "The supported server models for the images of the release.", "type": "string", "x-omitempty": true }, "minItems": 1, "nullable": true }, "Type": { "description": "The platform type for which the images are released. This can be a Fabric Interconnect or compute server hardware.\n* `FabricSwitch` - The images in a release that correspond to Fabric Interconnect switches.\n* `ComputeSystem` - The images in a release that correspond to servers.", "type": "string", "enum": [ "FabricSwitch", "ComputeSystem" ], "default": "FabricSwitch", "x-omitempty": true }, "Version": { "description": "Cisco provided release version.", "type": "string", "x-omitempty": true }, "Catalog": { "$ref": "#/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." } } } ] }, "softwarerepository.Release.List": { "title": "List of 'softwarerepository.Release' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'softwarerepository.Release' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'softwarerepository.Release' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/softwarerepository.Release" }, "nullable": true } } } ] }, "softwarerepository.UnsupportedModelConstraint": { "title": "Softwarerepository:Unsupported Model Constraint", "description": "It defines a constraint that given an image name and version, server models are unsupported for firmware upgrades.", "x-allOf-name": "softwarerepository.UnsupportedModelConstraint", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'softwarerepository.UnsupportedModelConstraint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "softwarerepository.UnsupportedModelConstraint" ], "default": "softwarerepository.UnsupportedModelConstraint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "softwarerepository.UnsupportedModelConstraint" ], "default": "softwarerepository.UnsupportedModelConstraint", "x-enum-as-string": true }, "MaxVersion": { "description": "UCSM version above which the server model is unsupported.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the platform constraint.", "type": "string", "x-omitempty": true }, "PlatformRegex": { "description": "Regular expression of the image name.", "type": "string", "x-omitempty": true }, "UnsupportedModels": { "type": "array", "items": { "description": "List of unsupported server models.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "sw.IdPoolBase": { "title": "Sw:Id Pool Base", "description": "Container representation of the Idpools defined for fabric.", "x-allOf-name": "sw.IdPoolBase", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'sw.IdPoolBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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.ServerIdPool", "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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.ServerIdPool", "equipment.ChassisIdPool" ], "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", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NextAvailableId": { "description": "Shows the next available Chassis ID to be allocated.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "task.CatalystSdwanScopedInventory": { "title": "Task:Catalyst Sdwan Scoped Inventory", "description": "CatalystSdwanScopedInventories represent an on-demand inventory trigger used to refresh inventory for a specific registered Catalyst SD-WAN device/connection. Creating one of these objects initiates a scoped discovery cycle to update modified objects in Intersight without waiting for the next scheduled inventory run.\n#### Purpose\nAllow administrators to manually trigger a targeted inventory refresh for a Catalyst SD-WAN registered device so Intersight reflects recent changes promptly.\n#### Key Concepts\n- **On-demand trigger (CREATE-only)**: The object is primarily an action/request used to start inventory, not a long-lived configuration resource.\n- **Scoped inventory behavior**: Extends `connector.ScopedInventory`, indicating the operation is limited to the specified device scope.\n- **Device targeting via registration**: `registeredDevice` (create-only) identifies the exact device registration to inventory.\n- **Permission inheritance**: Inherits permissions from `registeredDevice`, aligning access control with the underlying device registration.\n- **Lifecycle coupling**: `onpeerdelete: cascade` ties the trigger record to the device registration lifecycle.", "x-allOf-name": "task.CatalystSdwanScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.CatalystSdwanScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.CatalystSdwanScopedInventory" ], "default": "task.CatalystSdwanScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.CatalystSdwanScopedInventory" ], "default": "task.CatalystSdwanScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.FabricMosScopedInventory": { "title": "Task:Fabric Mos Scoped Inventory", "description": "API to trigger on-demand inventory to update MDS objects in Intersight.", "x-allOf-name": "task.FabricMosScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.FabricMosScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.FabricMosScopedInventory" ], "default": "task.FabricMosScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.FabricMosScopedInventory" ], "default": "task.FabricMosScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.HciScopedInventory": { "title": "Task:Hci Scoped Inventory", "description": "The HciScopedInventory object is a trigger for on-demand inventory collection for the specified set of managed objects.\n#### Purpose\nThe HciScopedInventory object facilitates the on-demand collection of inventory data from registered devices. It acts as a trigger for inventory updates, ensuring that the system reflects the current state of managed assets.\n#### Key Concepts\n- **Inventory Collection:** Initiates on-demand inventory collection processes to ensure data accuracy.", "x-allOf-name": "task.HciScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.HciScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.HciScopedInventory" ], "default": "task.HciScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.HciScopedInventory" ], "default": "task.HciScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.HitachiScopedInventory": { "title": "Task:Hitachi Scoped Inventory", "description": "The HitachiScopedInventory object provides an API to trigger on-demand HitachiStorage FlashArray inventory updates, supporting effective storage system reporting.\n#### Purpose\nHitachiScopedInventory is fundamental to managing inventory updates within Hitachi arrays. It ensures accurate and timely reporting of modified objects, supporting efficient storage system operations.\n#### Key Concepts\n- **Inventory Management:** Facilitates on-demand inventory updates, ensuring accurate and current reporting of storage system changes.\n- **API Integration:** Provides a structured API for inventory updates, supporting seamless integration within the Intersight system.\n- **Device Registration:** Connects inventory updates to device registration objects, ensuring reliable communication and reporting.\n- **Access Control:** Utilizes privilege sets to ensure secure and authorized operations on inventory updates.", "x-allOf-name": "task.HitachiScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.HitachiScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.HitachiScopedInventory" ], "default": "task.HitachiScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.HitachiScopedInventory" ], "default": "task.HitachiScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.HyperFlexManagementScopedInventory": { "title": "Task:Hyper Flex Management Scoped Inventory", "description": "HyperFlexManagementScopedInventories are task-trigger objects used to initiate an on-demand HyperFlex inventory collection for a specific registered HyperFlex endpoint. They are intended to refresh Intersight\u2019s reported state by collecting updated data for the associated device.\n#### Purpose\nProvide an API mechanism to manually trigger inventory collection so that recently changed HyperFlex-managed objects are re-discovered and reflected in Intersight reports without waiting for the next scheduled inventory cycle.\n#### Key Concepts\n- **On-demand inventory trigger:** Creating this object starts an immediate inventory refresh workflow for the target device.\n- **Device-scoped execution:** The operation is explicitly bound to a single `registeredDevice` (an `asset.DeviceRegistration`).\n- **Scoped inventory base:** Extends `connector.ScopedInventory`, aligning with the platform\u2019s standard pattern for inventory-trigger requests.\n- **Permission inheritance:** Inherits permissions from `registeredDevice`, ensuring only authorized users can trigger collection for that device.\n- **Lifecycle coupling:** Uses `onpeerdelete: cascade` so if the device registration is removed, the associated trigger object is cleaned up.", "x-allOf-name": "task.HyperFlexManagementScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.HyperFlexManagementScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.HyperFlexManagementScopedInventory" ], "default": "task.HyperFlexManagementScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.HyperFlexManagementScopedInventory" ], "default": "task.HyperFlexManagementScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.HyperflexScopedInventory": { "title": "Task:Hyperflex Scoped Inventory", "description": "API to trigger on-demand Hyperflex Cluster inventory to update modified objects in Intersight report.", "x-allOf-name": "task.HyperflexScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.HyperflexScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.HyperflexScopedInventory" ], "default": "task.HyperflexScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.HyperflexScopedInventory" ], "default": "task.HyperflexScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.MdsScopedInventory": { "title": "Task:Mds Scoped Inventory", "description": "API to trigger on-demand MDS inventory to update modified objects in Intersight report.", "x-allOf-name": "task.MdsScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.MdsScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.MdsScopedInventory" ], "default": "task.MdsScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.MdsScopedInventory" ], "default": "task.MdsScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.MdsSystemScopedInventory": { "title": "Task:Mds System Scoped Inventory", "description": "API to trigger on-demand MDS System inventory after the workflow execution.", "x-allOf-name": "task.MdsSystemScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.MdsSystemScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.MdsSystemScopedInventory" ], "default": "task.MdsSystemScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.MdsSystemScopedInventory" ], "default": "task.MdsSystemScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.MerakiScopedInventory": { "title": "Task:Meraki Scoped Inventory", "description": "API to trigger on-demand inventory to update modified objects.", "x-allOf-name": "task.MerakiScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.MerakiScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.MerakiScopedInventory" ], "default": "task.MerakiScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.MerakiScopedInventory" ], "default": "task.MerakiScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.NetAppScopedInventory": { "title": "Task:Net App Scoped Inventory", "description": "API to trigger on-demand NetAppStorage inventory to update modified objects in Intersight report.", "x-allOf-name": "task.NetAppScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.NetAppScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.NetAppScopedInventory" ], "default": "task.NetAppScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.NetAppScopedInventory" ], "default": "task.NetAppScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.NexusScopedInventory": { "title": "Task:Nexus Scoped Inventory", "description": "API to trigger on-demand Nexus inventory to update modified objects in Intersight report.", "x-allOf-name": "task.NexusScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.NexusScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.NexusScopedInventory" ], "default": "task.NexusScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.NexusScopedInventory" ], "default": "task.NexusScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.NexusSystemScopedInventory": { "title": "Task:Nexus System Scoped Inventory", "description": "API to trigger on-demand Nexus SNMP inventory to update modified objects in Intersight report.", "x-allOf-name": "task.NexusSystemScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.NexusSystemScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.NexusSystemScopedInventory" ], "default": "task.NexusSystemScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.NexusSystemScopedInventory" ], "default": "task.NexusSystemScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.NexusVlanScopedInventory": { "title": "Task:Nexus Vlan Scoped Inventory", "description": "API to trigger on-demand Nexus VLAN inventory to update modified objects in Intersight report.", "x-allOf-name": "task.NexusVlanScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.NexusVlanScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.NexusVlanScopedInventory" ], "default": "task.NexusVlanScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.NexusVlanScopedInventory" ], "default": "task.NexusVlanScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.PureFlashBladeScopedInventory": { "title": "Task:Pure Flash Blade Scoped Inventory", "description": "The PureFlashBladeScopedInventory object provides on-demand inventory management for FlashBlade storage arrays, enabling dynamic updates to managed objects following operational changes.\n#### Purpose\nThis object is used to trigger inventory refreshes, ensuring that any modifications to the FlashBlade array are accurately reflected in management reports. It supports administrators in maintaining up-to-date information for audit, compliance, and operational efficiency.\n#### Key Concepts\n- **Inventory Refresh**: Allows for immediate updating of FlashBlade inventory post-operations, enhancing data accuracy.\n- **Automation Support**: Integrates with batch API executors, enabling automated inventory management workflows.\n- **Management Integration**: Works alongside device registration to ensure consistent reporting across management platforms.\n- **Privilege Control**: Access is restricted to authorized users, maintaining security and compliance.", "x-allOf-name": "task.PureFlashBladeScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.PureFlashBladeScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.PureFlashBladeScopedInventory" ], "default": "task.PureFlashBladeScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.PureFlashBladeScopedInventory" ], "default": "task.PureFlashBladeScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.PureScopedInventory": { "title": "Task:Pure Scoped Inventory", "description": "API to trigger on-demand PureStorage FlashArray inventory to update modified objects in Intersight report.", "x-allOf-name": "task.PureScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.PureScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.PureScopedInventory" ], "default": "task.PureScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.PureScopedInventory" ], "default": "task.PureScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "task.ServerScopedInventory": { "title": "Task:Server Scoped Inventory", "description": "API to trigger on-demand Server inventory to update modified objects in Intersight report.", "x-allOf-name": "task.ServerScopedInventory", "allOf": [ { "$ref": "#/components/schemas/connector.ScopedInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'task.ServerScopedInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "task.ServerScopedInventory" ], "default": "task.ServerScopedInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "task.ServerScopedInventory" ], "default": "task.ServerScopedInventory", "x-enum-as-string": true }, "RegisteredDevice": { "$ref": "#/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.", "x-createOnly": true } } } ] }, "techsupportmanagement.ApplianceParam": { "title": "Techsupportmanagement:Appliance Param", "description": "Appliance parameter object for Tech Support requests.", "x-allOf-name": "techsupportmanagement.ApplianceParam", "allOf": [ { "$ref": "#/components/schemas/connector.PlatformParamBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.ApplianceParam', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "techsupportmanagement.ApplianceParam" ], "default": "techsupportmanagement.ApplianceParam", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "techsupportmanagement.ApplianceParam" ], "default": "techsupportmanagement.ApplianceParam", "x-enum-as-string": true }, "IsApplianceRequest": { "description": "Specifies whether the techsupport request is from the cloud or by the appliance.", "type": "boolean", "x-omitempty": true } } } ] }, "techsupportmanagement.CollectionControlPolicy.Response": { "description": "The response body of a HTTP GET request for the 'techsupportmanagement.CollectionControlPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'techsupportmanagement.CollectionControlPolicy' resources.", "x-one-of-name": "techsupportmanagement.CollectionControlPolicy.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/techsupportmanagement.CollectionControlPolicy.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "techsupportmanagement.CollectionControlPolicy": { "title": "Techsupportmanagement:Collection Control Policy", "description": "Policy to control techsupport collection for a specific account.", "x-allOf-name": "techsupportmanagement.CollectionControlPolicy", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.CollectionControlPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "techsupportmanagement.CollectionControlPolicy" ], "default": "techsupportmanagement.CollectionControlPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "techsupportmanagement.CollectionControlPolicy" ], "default": "techsupportmanagement.CollectionControlPolicy", "x-enum-as-string": true }, "DeploymentType": { "description": "Deployment type defines whether the policy is associated with a SaaS or Appliance account.\n* `None` - Service deployment type None.\n* `SaaS` - Service deployment type SaaS.\n* `Appliance` - Service deployment type Appliance.", "type": "string", "enum": [ "None", "SaaS", "Appliance" ], "default": "None", "readOnly": true, "x-omitempty": true }, "TechSupportCollection": { "description": "Enable or Disable techsupport collection for a specific account.\n* `Enable` - Enable techsupport collection.\n* `Disable` - Disable techsupport collection.", "type": "string", "enum": [ "Enable", "Disable" ], "default": "Enable", "x-omitempty": true }, "Account": { "$ref": "#/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 } } } ] }, "techsupportmanagement.CollectionControlPolicy.List": { "title": "List of 'techsupportmanagement.CollectionControlPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'techsupportmanagement.CollectionControlPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'techsupportmanagement.CollectionControlPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/techsupportmanagement.CollectionControlPolicy" }, "nullable": true } } } ] }, "techsupportmanagement.Download.Response": { "description": "The response body of a HTTP GET request for the 'techsupportmanagement.Download' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'techsupportmanagement.Download' resources.", "x-one-of-name": "techsupportmanagement.Download.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/techsupportmanagement.Download.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "techsupportmanagement.Download": { "title": "Techsupportmanagement:Download", "description": "Download the techsupport file. The response to this API will be the actual techsupport file. This API needs to be invoked using the download link obtained by doing GET operation on TechsupportStatus. The techsupportDownloadUrl property in the TechsupportStatus API response will have the download link. No other link can be used to download the techsupport file.", "x-allOf-name": "techsupportmanagement.Download", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.Download', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "techsupportmanagement.Download" ], "default": "techsupportmanagement.Download", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "techsupportmanagement.Download" ], "default": "techsupportmanagement.Download", "x-enum-as-string": true }, "TechSupportStatus": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportStatus.Relationship", "description": "A reference to a techsupportmanagementTechSupportStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "techsupportmanagement.Download.List": { "title": "List of 'techsupportmanagement.Download' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'techsupportmanagement.Download' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'techsupportmanagement.Download' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/techsupportmanagement.Download" }, "nullable": true } } } ] }, "techsupportmanagement.EndPoint.Response": { "description": "The response body of a HTTP GET request for the 'techsupportmanagement.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 'techsupportmanagement.EndPoint' resources.", "x-one-of-name": "techsupportmanagement.EndPoint.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/techsupportmanagement.EndPoint.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "techsupportmanagement.EndPoint": { "title": "Techsupportmanagement:End Point", "description": "An endpoint that has registered for techsupport collection service on Intersight. Intersight services must create an Endpoint MO for every endpoint (hardware device or software appliance) that requires techsupport collection. An endpoint is uniquely identified based on the combination of serial and pid.", "x-allOf-name": "techsupportmanagement.EndPoint", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.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": [ "techsupportmanagement.EndPoint" ], "default": "techsupportmanagement.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": [ "techsupportmanagement.EndPoint" ], "default": "techsupportmanagement.EndPoint", "x-enum-as-string": true }, "DeviceMoid": { "description": "The device registration moid of the endpoint device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceType": { "description": "The device object type for the managed end point.", "type": "string", "readOnly": true, "x-omitempty": true }, "Dn": { "description": "The distinguished name, if any, for the managed end point.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "The product identifier of the managed end point.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformType": { "description": "The platform type of the managed end point.\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 }, "Serial": { "description": "The serial identifier for the managed end point.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterMember": { "$ref": "#/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." }, "DeviceRegistration": { "$ref": "#/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." }, "TargetResource": { "$ref": "#/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." } } } ] }, "techsupportmanagement.EndPoint.List": { "title": "List of 'techsupportmanagement.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": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'techsupportmanagement.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 'techsupportmanagement.EndPoint' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/techsupportmanagement.EndPoint" }, "nullable": true } } } ] }, "techsupportmanagement.NiaParam": { "title": "Techsupportmanagement:Nia Param", "description": "NIA parameter object for Tech Support requests.", "x-allOf-name": "techsupportmanagement.NiaParam", "allOf": [ { "$ref": "#/components/schemas/connector.PlatformParamBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.NiaParam', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "techsupportmanagement.NiaParam" ], "default": "techsupportmanagement.NiaParam", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "techsupportmanagement.NiaParam" ], "default": "techsupportmanagement.NiaParam", "x-enum-as-string": true }, "CollectionClass": { "description": "CollectionClass specifies which app to collect ND techsupport from - infra/NDI/NDO/NDFC.\n* `1` - Collect infra logs for Nexus Dashboard TACASSIST.\n* `2` - Collect logs for Nexus Dashboard Insights app through NDTACASSIST.\n* `3` - Collect logs for Nexus Dashboard Orchestrator app through NDTACASSIST.\n* `4` - Collect logs for Nexus Dashboard Fabric Controller app through NDTACASSIST.\n* `5` - Collect logs for Nexus Data Broker app through NDTACASSIST.\n* `6` - Collect logs for Nexus Data Broker Orchestrator app through NDTACASSIST.", "type": "integer", "enum": [ 1, 2, 3, 4, 5, 6 ], "default": 1, "x-omitempty": true }, "CollectionLevel": { "description": "CollectionLevel controls the size / depth of the tech support files collected.\n* `1` - Use cached data in the returned collection.\n* `2` - Use current data in the returned collection.", "type": "integer", "enum": [ 1, 2 ], "default": 1, "x-omitempty": true }, "Filename": { "description": "Filename specifies an individual filename to collect from the endpoint.", "type": "string", "x-omitempty": true }, "ForceFresh": { "description": "ForceFresh controls whether to return pre-collected files or force the collection of new files.", "type": "boolean", "x-omitempty": true }, "Period": { "description": "Number of days for which to collect techsupport.", "type": "integer", "format": "int64", "default": 2, "x-omitempty": true }, "Pids": { "type": "array", "items": { "description": "List of PIDs to collect from in the NIA environment.", "type": "string", "x-omitempty": true }, "nullable": true }, "SerialNumbers": { "type": "array", "items": { "description": "List of serial numbers to collect from in the NIA environment.", "type": "string", "x-omitempty": true }, "nullable": true }, "ShowTechOption": { "description": "ShowTechOption specifies an optional custom show-tech option/command for NDFC tech support collection.", "type": "string", "x-omitempty": true }, "UpgradeLogs": { "description": "UpgradeLogs controls the inclusion of upgrade logs in tech support bundles.", "type": "boolean", "x-omitempty": true } } } ] }, "techsupportmanagement.PlatformParam": { "title": "Techsupportmanagement:Platform Param", "description": "Parameter object for techsupport request that can be used to specify techsupport collection pararmeters.", "x-allOf-name": "techsupportmanagement.PlatformParam", "allOf": [ { "$ref": "#/components/schemas/connector.PlatformParamBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.PlatformParam', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "techsupportmanagement.PlatformParam" ], "default": "techsupportmanagement.PlatformParam", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "techsupportmanagement.PlatformParam" ], "default": "techsupportmanagement.PlatformParam", "x-enum-as-string": true }, "CollectionType": { "description": "CollectionType specifies if basic or detailed techsupport needs to be collected.\n* `1` - Collect basic techsupport.\n* `2` - Collect detailed techsupport.", "type": "integer", "enum": [ 1, 2 ], "default": 1, "x-omitempty": true }, "IncludeCore": { "description": "Controls whether to include core file in the techsupport bundle.", "type": "boolean", "x-omitempty": true } } } ] }, "techsupportmanagement.TechSupportBundle.Response": { "description": "The response body of a HTTP GET request for the 'techsupportmanagement.TechSupportBundle' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'techsupportmanagement.TechSupportBundle' resources.", "x-one-of-name": "techsupportmanagement.TechSupportBundle.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/techsupportmanagement.TechSupportBundle.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "techsupportmanagement.TechSupportBundle.Relationship": { "description": "A relationship to the 'techsupportmanagement.TechSupportBundle' resource, or the expanded 'techsupportmanagement.TechSupportBundle' resource, or the 'null' value.", "x-one-of-name": "techsupportmanagement.TechSupportBundle.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/techsupportmanagement.TechSupportBundle" } ], "discriminator": { "propertyName": "ClassId" } }, "techsupportmanagement.TechSupportBundle": { "title": "Techsupportmanagement:Tech Support Bundle", "description": "A request to collect techsupport and upload it to Intersight Storage Service. The serial number, PID and/or relationship to the target resource provided by the user is used to determine the device type for techsupport collection. If the serial number, PID and target resource are specified in the request, the values must match. Valid values of device types are network.Element for fabric interconnect, compute.Blade for blade server, compute.RackUnit for rack server, equipment.Chassis for chassis, equipment.IoCard for IO Module, equipment.FEX for fabric extender and adapter.Unit for network adapter. UCSM techsupport is collected for device type network.Element. Chassis techsupport is collected for compute.Blade, equipment.Chassis, equipment.IoCard, and blade adapter.Unit. Server techsupport is collected for compute.RackUnit and rack adapter.Unit. Fabric extender techsupport is collected for device type equipment.FEX. Hyper Flex node level techsupport is collected when the request specifies the platform type (HX) and the device type is Hyperflex.Node.", "x-allOf-name": "techsupportmanagement.TechSupportBundle", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.TechSupportBundle', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "techsupportmanagement.TechSupportBundle" ], "default": "techsupportmanagement.TechSupportBundle", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "techsupportmanagement.TechSupportBundle" ], "default": "techsupportmanagement.TechSupportBundle", "x-enum-as-string": true }, "DeviceIdentifier": { "description": "The device identifier used to uniquely identify an individual device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceType": { "description": "The device type obtained from the inventory.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "Product identification of the device.", "type": "string", "x-omitempty": true }, "PlatformParam": { "description": "A platform specific data payload.", "$ref": "#/components/schemas/connector.PlatformParamBase", "x-omitempty": true }, "PlatformType": { "description": "The platform type of the device.\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 }, "Serial": { "description": "Serial number of the device.", "type": "string", "x-omitempty": true }, "DeviceRegistration": { "$ref": "#/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 }, "TargetResource": { "$ref": "#/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." }, "TechSupportStatus": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportStatus.Relationship", "description": "A reference to a techsupportmanagementTechSupportStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "techsupportmanagement.TechSupportBundle.List": { "title": "List of 'techsupportmanagement.TechSupportBundle' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'techsupportmanagement.TechSupportBundle' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'techsupportmanagement.TechSupportBundle' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportBundle" }, "nullable": true } } } ] }, "techsupportmanagement.TechSupportFileInfo": { "title": "Techsupportmanagement:Tech Support File Info", "description": "TechSupportFileInfo contains information regarding a single techsupport file produced by a techsupport collection that produces multiple files. A user can track the progress of a particular file in the collection by monitoring the UploadStatus field for that file. This field will progress from \"UploadQueued\", to \"UploadPending\", to \"UploadInProgress\", and finally to one of several terminal states. Possible terminal states for a file include \"Completed\" for a successful collection, and \"UploadFailed\" or \"TechsupportDownloadUrlCreationFailed\" for an unsuccessful collection. For a file that successfully uploads, the file may be retrieved through the link in the TechsupportDownloadUrl field. Note that for a typical techsupport collection that produces a single file, rather than multiple, this type will not be utilized.", "x-allOf-name": "techsupportmanagement.TechSupportFileInfo", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.TechSupportFileInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "techsupportmanagement.TechSupportFileInfo" ], "default": "techsupportmanagement.TechSupportFileInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "techsupportmanagement.TechSupportFileInfo" ], "default": "techsupportmanagement.TechSupportFileInfo", "x-enum-as-string": true }, "FileName": { "description": "The name of the techsupport file.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileSize": { "description": "Techsupport file size in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "Reason for techsupport failure, if any.", "type": "string", "readOnly": true, "x-omitempty": true }, "TechsupportDownloadUrl": { "description": "The Url to download the techsupport file.", "type": "string", "readOnly": true, "x-omitempty": true }, "UploadStatus": { "description": "The upload status of the techsupport file.", "type": "string", "default": "UploadQueued", "readOnly": true, "x-omitempty": true } } } ] }, "techsupportmanagement.TechSupportStatus.Response": { "description": "The response body of a HTTP GET request for the 'techsupportmanagement.TechSupportStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'techsupportmanagement.TechSupportStatus' resources.", "x-one-of-name": "techsupportmanagement.TechSupportStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/techsupportmanagement.TechSupportStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "techsupportmanagement.TechSupportStatus.Relationship": { "description": "A relationship to the 'techsupportmanagement.TechSupportStatus' resource, or the expanded 'techsupportmanagement.TechSupportStatus' resource, or the 'null' value.", "x-one-of-name": "techsupportmanagement.TechSupportStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/techsupportmanagement.TechSupportStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "techsupportmanagement.TechSupportStatus": { "title": "Techsupportmanagement:Tech Support Status", "description": "The techsupport collection status.", "x-allOf-name": "techsupportmanagement.TechSupportStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'techsupportmanagement.TechSupportStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "techsupportmanagement.TechSupportStatus" ], "default": "techsupportmanagement.TechSupportStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "techsupportmanagement.TechSupportStatus" ], "default": "techsupportmanagement.TechSupportStatus", "x-enum-as-string": true }, "FileName": { "description": "The name of the Techsupport bundle file.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileSize": { "description": "Techsupport file size in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "Reason for techsupport failure, if any.", "type": "string", "readOnly": true, "x-omitempty": true }, "RelayReason": { "description": "Reason for status relay failure, if any.", "type": "string", "readOnly": true, "x-omitempty": true }, "RelayStatus": { "description": "Status of techsupport status relay. Valid values are NoRelay, Pending, Completed, and Failed.", "type": "string", "readOnly": true, "x-omitempty": true }, "RequestTs": { "description": "The time at which the techsupport request was initiated.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the techsupport collection. Valid values are Scheduled, Pending, CollectionInProgress, CollectionFailed, CollectionComplete, UploadPending, UploadInProgress, UploadPartsComplete, UploadPreparingNextFile, UploadFailed, TechsupportDownloadUrlCreationFailed, PartiallyCompleted, AwaitingAllCollections, and Completed. The final status will be one of CollectionFailed, UploadFailed, or TechsupportDownloadUrlCreationFailed if there is a failure, Completed if the request completed successfully and the file (or files) were uploaded to Intersight Storage Service, or PartiallyCompleted if at least one file in a multiple file collection uploaded successfully. AwaitingAllCollections is a transient status used when regular techsupport collection fails but PseudoSamTech collection is still in progress. All the remaining status values indicates the progress of techsupport collection.", "type": "string", "readOnly": true, "x-omitempty": true }, "TechsupportDownloadUrl": { "description": "The Url to download the techsupport file.", "type": "string", "readOnly": true, "x-omitempty": true }, "TechsupportFiles": { "type": "array", "items": { "description": "List of collected files for a single tech support request.", "$ref": "#/components/schemas/techsupportmanagement.TechSupportFileInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UserRole": { "description": "The name of the role granted to the user that issued the techsupport request.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterMember": { "$ref": "#/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 }, "DeviceRegistration": { "$ref": "#/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." }, "OriginResource": { "$ref": "#/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." }, "TechSupportRequest": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportBundle.Relationship", "description": "A reference to a techsupportmanagementTechSupportBundle resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "techsupportmanagement.TechSupportStatus.List": { "title": "List of 'techsupportmanagement.TechSupportStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'techsupportmanagement.TechSupportStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'techsupportmanagement.TechSupportStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/techsupportmanagement.TechSupportStatus" }, "nullable": true } } } ] }, "template.TransformationStage": { "title": "Template:Transformation Stage", "description": "In Intersight workflows, task inputs may require data in a specific format. When the available value does not match the expected form, it must be transformed before it can be used.\n#### Purpose\nTransformation stages allow users to apply a sequence of data transformations. Each stage processes the output from the previous stage, ensuring that the final value matches the format required by the task input parameter in the workflow definition.\n#### Key Concept\n- **Data Conversion:** Each transformation stage defines how input data is converted or modified before being mapped to a task input parameter. This ensures that data conforms to the required format and structure defined in the workflow.\n- **Chained Processing:** Multiple transformation stages can be linked together, where each stage processes the output of the previous one. This sequential approach ensures that the final transformed value precisely matches the format expected by the workflow task.\n- **Traceability:** All transformation details are retained within the workflow and task definitions, enabling visibility, auditability, and easier troubleshooting of data flow within the workflow.", "x-allOf-name": "template.TransformationStage", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'template.TransformationStage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "template.TransformationStage" ], "default": "template.TransformationStage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "template.TransformationStage" ], "default": "template.TransformationStage", "x-enum-as-string": true }, "Function": { "description": "The function to be executed.", "type": "string", "x-omitempty": true }, "FunctionArguments": { "description": "A collection of arguments for the function being executed.", "nullable": true, "x-omitempty": true }, "Name": { "description": "The unique name by which the output of this transformation stage can be accessed in further stages. Only alphanumeric characters are allowed.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]{1,64}$", "x-omitempty": true } } } ] }, "top.System.Response": { "description": "The response body of a HTTP GET request for the 'top.System' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'top.System' resources.", "x-one-of-name": "top.System.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/top.System.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "top.System.Relationship": { "description": "A relationship to the 'top.System' resource, or the expanded 'top.System' resource, or the 'null' value.", "x-one-of-name": "top.System.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/top.System" } ], "discriminator": { "propertyName": "ClassId" } }, "top.System": { "title": "Top:System", "description": "Root container for all UCSM / CIMC MOs.", "x-allOf-name": "top.System", "allOf": [ { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'top.System', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "top.System" ], "default": "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.", "enum": [ "top.System" ], "default": "top.System", "x-enum-as-string": true }, "Ipv4Address": { "description": "The IPv4 address of system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv6Address": { "description": "The IPv6 address of system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mode": { "description": "The current mode of the system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The admin configured name of the system.", "type": "string", "readOnly": true, "x-omitempty": true }, "TimeZone": { "description": "The operational timezone of the system, empty indicates no timezone has been set specifically.", "type": "string", "x-omitempty": true }, "ComputeBlades": { "description": "An array of relationships to computeBlade resources.", "type": "array", "items": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/compute.Blade.Relationship" }, "nullable": true }, "ComputeRackUnits": { "description": "An array of relationships to computeRackUnit resources.", "type": "array", "items": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/compute.RackUnit.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/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": "intersight-server-v3-1.0.11-20260807064027971.json#/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 }, "RegisteredDevice": { "$ref": "#/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 } } } ] }, "top.System.List": { "title": "List of 'top.System' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'top.System' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'top.System' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/top.System" }, "nullable": true } } } ] }, "tunneling.Tunnel": { "title": "Tunneling:Tunnel", "description": "The tunnel that exists between the client and the DC.", "x-allOf-name": "tunneling.Tunnel", "allOf": [ { "$ref": "#/components/schemas/session.AbstractSubSession" }, { "type": "object", "description": "Definition of the list of properties defined in 'tunneling.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.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "kvm.Tunnel", "vmrc.Console" ], "x-enum-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": [ "kvm.Tunnel", "vmrc.Console" ], "x-enum-as-string": true }, "ClientUrl": { "description": "The multiplexer URL for the client to connect on.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "ucsdconnector.RestClientMessage": { "title": "Ucsdconnector:Rest Client Message", "description": "RestClient Message type which would constitute of the following types.", "x-allOf-name": "ucsdconnector.RestClientMessage", "allOf": [ { "$ref": "#/components/schemas/connector.AuthMessage" }, { "type": "object", "description": "Definition of the list of properties defined in 'ucsdconnector.RestClientMessage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ucsdconnector.RestClientMessage" ], "default": "ucsdconnector.RestClientMessage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ucsdconnector.RestClientMessage" ], "default": "ucsdconnector.RestClientMessage", "x-enum-as-string": true }, "Body": { "description": "Payload which is sent along with the request. Most applicable to POST methods.", "type": "string", "x-omitempty": true }, "Header": { "description": "Headers to be passed with the HTTP rest request.", "nullable": true, "x-omitempty": true }, "Method": { "description": "REST Method, should be set to one of [HTTP.MethodGet, HTTP.MethodPost].", "type": "string", "x-omitempty": true }, "RestUrl": { "description": "REST URL endpoint to which the HTTP request is sent.", "type": "string", "x-omitempty": true } } } ] }, "view.HealthStatus.Response": { "description": "The response body of a HTTP GET request for the 'view.HealthStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'view.HealthStatus' resources.", "x-one-of-name": "view.HealthStatus.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/view.HealthStatus.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "view.HealthStatus": { "title": "View:Health Status", "description": "The HealthStatus object is designed to provide a high-level, aggregated status of Intersight components for a given account user. It informs users about potential issues that may require their attention, offering a comprehensive view of the system's health status.\n#### Purpose\nThe HealthStatus object serves as a central indicator of the health of various components within the Intersight ecosystem. It consolidates status information for multiple categories like 'Licensing', 'Advisories', and 'Alarms', making it easier for users to understand the overall condition of their system and take necessary actions.\n#### Key Concepts\n- **Aggregated Status:** Combines the status of multiple Intersight categories, providing a concise snapshot of system health.\n- **Dashboard Integration:** Specifically designed to be easily consumed by external dashboards for at-a-glance status visualization.\n- **Read-Only Access:** Ensures that the status information is reliable and consistent, allowing users to focus on monitoring rather than modifying.", "x-allOf-name": "view.HealthStatus", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" } ] }, "view.HealthStatus.List": { "title": "List of 'view.HealthStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'view.HealthStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'view.HealthStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/view.HealthStatus" }, "nullable": true } } } ] }, "view.Server.Response": { "description": "The response body of a HTTP GET request for the 'view.Server' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'view.Server' resources.", "x-one-of-name": "view.Server.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/view.Server.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "view.Server": { "title": "View:Server", "description": "The Server object facilitates querying a list of UCS servers, including API resource types compute.Blade and compute.RackUnit, along with associated managed object information.\n#### Purpose\nThe Server object is intended to provide a REST endpoint for accessing and managing server-related data within the UCS ecosystem. It helps users query comprehensive server information, supporting various operational and management tasks.\n#### Key Concepts\n- **REST Endpoint:** Offers a standardized interface for querying server data, supporting OData operators for filtering and ordering results.\n- **Integration with MO Information:** Allows access to related managed object information such as device registration and health status.", "x-allOf-name": "view.Server", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" } ] }, "view.Server.List": { "title": "List of 'view.Server' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'view.Server' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'view.Server' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/view.Server" }, "nullable": true } } } ] }, "workload.AssignedResource": { "title": "Workload:Assigned Resource", "description": "Resource that has been assigned to a workload instance.", "x-allOf-name": "workload.AssignedResource", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.AssignedResource', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.AssignedResource" ], "default": "workload.AssignedResource", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.AssignedResource" ], "default": "workload.AssignedResource", "x-enum-as-string": true }, "BluePrint": { "description": "The blueprint used to provision the assigned resource.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "BluePrintRefName": { "description": "The reference name for the blueprint as given in the workload definition.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9_]{0,63}$", "readOnly": true, "x-omitempty": true }, "Lease": { "description": "The lease details associated with the assigned resource.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Resource": { "description": "The primary resource assigned to the workload instance.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "ServiceItemInstance": { "description": "The service item instance linked to the assigned resource.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true } } } ] }, "workload.BaseBlueprintReference": { "title": "Workload:Base Blueprint Reference", "description": "Base type to capture all details about the referenced blueprint. This base type will be used to capture referenced blueprint details within Workload and Deployments.", "x-allOf-name": "workload.BaseBlueprintReference", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.BaseBlueprintReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "workload.BlueprintInputReference", "workload.BlueprintReference", "workload.DeploymentBlueprintInputType" ], "x-enum-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": [ "workload.BlueprintInputReference", "workload.BlueprintReference", "workload.DeploymentBlueprintInputType" ], "x-enum-as-string": true }, "Blueprint": { "description": "The referred blueprint details.", "$ref": "#/components/schemas/mo.MoRef", "x-omitempty": true }, "Input": { "description": "The input data for the referred blueprint. All required inputs of the blueprint must have a value provided.", "x-omitempty": true }, "Name": { "description": "The name for the referred blueprint. This name must be unique within the workload definition.", "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9- _]{0,31}$", "maxLength": 32, "x-createOnly": true, "x-omitempty": true }, "RefName": { "description": "The reference name for the blueprint which is derived by the system.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9_]{0,31}$", "readOnly": true, "x-omitempty": true }, "ResourceConstraint": { "description": "The constraints that need to be applied to the resources in order to match this blueprint.", "$ref": "#/components/schemas/workload.ResourceConstraint", "x-omitempty": true } } } ] }, "workload.BatchDeployment": { "title": "Workload:Batch Deployment", "description": "The number of instances to be included in each batch during the deployment..", "x-allOf-name": "workload.BatchDeployment", "allOf": [ { "$ref": "#/components/schemas/workload.RolloutStrategy" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.BatchDeployment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.BatchDeployment" ], "default": "workload.BatchDeployment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.BatchDeployment" ], "default": "workload.BatchDeployment", "x-enum-as-string": true }, "BatchSize": { "description": "The number of instances to be included in each batch during the deployment.", "type": "integer", "format": "int64", "default": 20, "minimum": 1, "readOnly": true, "x-omitempty": true } } } ] }, "workload.Blueprint.Response": { "description": "The response body of a HTTP GET request for the 'workload.Blueprint' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workload.Blueprint' resources.", "x-one-of-name": "workload.Blueprint.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workload.Blueprint.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workload.Blueprint": { "title": "Blueprint Definition", "description": "### Overview\nThe Blueprint object defines a reusable, versioned template for deploying infrastructure configurations and services. It encapsulates input schemas, managed object generation rules, service item associations, and resource constraints into a cohesive deployment unit that can be referenced by workload definitions.\n#### Purpose\nA Blueprint serves as a modular building block for constructing complex workload definitions. Blueprints provides a standardized way to define infrastructure patterns, application configurations, and service deployments that can be reused across multiple workloads. Blueprints support versioning, platform targeting, and dependency management to ensure reliable and consistent deployments.\n#### Key Concepts\n- **Versioning and Default Versions:** - Each blueprint supports multiple versions with the ability to designate a default version, enabling safe evolution of blueprint specifications while maintaining compatibility with existing workloads.\n- **Input Definition Schema:** - Defines the schema for all inputs required by the blueprint, supporting complex data types including primitives, collections, and managed object references.\n- **Generated Object Management:** - Specifies which Intersight managed objects (policies, profiles, etc.) should be automatically generated from blueprint inputs and how those objects should be configured.\n- **Service Item Integration:** - Associates service items with the blueprint, defining which service workflows are executed during deployment and lifecycle operations.\n- **Resource Constraints:** - Defines infrastructure resource requirements and constraints that must be satisfied for successful blueprint deployment.\n- **Blueprint Dependencies:** - Supports declaring dependencies on other blueprints, enabling compositional patterns and ensuring all required components are available during deployment.\n- **Platform Targeting:** - Specifies which Intersight platform types the blueprint supports, ensuring deployments only target compatible infrastructure.", "x-allOf-name": "workload.Blueprint", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.Blueprint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.Blueprint" ], "default": "workload.Blueprint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.Blueprint" ], "default": "workload.Blueprint", "x-enum-as-string": true }, "BlueprintDependencies": { "type": "array", "items": { "description": "The blueprints that this blueprint depends on.", "$ref": "#/components/schemas/blueprint.BlueprintDefinitionDependency", "x-omitempty": true }, "nullable": true }, "DefaultVersion": { "description": "The flag to indicate that this is the default version of the blueprint.", "type": "boolean", "default": false, "x-omitempty": true }, "Description": { "description": "The description for this blueprint which provides information on what are the pre-requisites to deploy the blueprint and what features are supported on the blueprint.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "ExternalMeta": { "description": "When set to false the blueprint is created for use within internal services.", "type": "boolean", "default": false, "x-omitempty": true }, "GeneratedObjectDefinition": { "type": "array", "items": { "description": "The generated objects from the blueprint.", "$ref": "#/components/schemas/blueprint.GeneratedObjectMetadata", "x-omitempty": true }, "nullable": true }, "InputDefinition": { "type": "array", "items": { "description": "The schema for inputs required by the blueprint.", "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.BaseDataType", "x-omitempty": true }, "nullable": true }, "InputOperationMetadata": { "type": "array", "items": { "description": "The operation details for the inputs.", "$ref": "#/components/schemas/blueprint.InputOperationType", "x-omitempty": true }, "nullable": true }, "Label": { "description": "A user friendly short name to identify the blueprint. Name can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), period (.), colon (:), space ( ) or an underscore (_).", "type": "string", "pattern": "^[a-zA-Z0-9]+[\\sa-zA-Z0-9_.:-]{1,31}$", "x-omitempty": true }, "Name": { "description": "The name for this blueprint. You can have multiple versions of the blueprint with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), or an underscore (_).", "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_]{0,31}$", "x-createOnly": true, "x-omitempty": true }, "PlatformType": { "description": "The Intersight platforms supported by this blueprint.\n* `None` - Default value is none, platform is not mentioned.\n* `UnifiedEdge` - The blueprint is created for Unified Edge platform.", "type": "string", "enum": [ "None", "UnifiedEdge" ], "default": "None", "x-omitempty": true }, "ResourceDefinition": { "description": "The resource constraint definition for the blueprint.", "$ref": "#/components/schemas/blueprint.ResourceConstraints", "x-omitempty": true }, "ServiceItems": { "type": "array", "items": { "description": "The service items that are part of the blueprint.", "$ref": "#/components/schemas/blueprint.ServiceItemDefinition", "x-omitempty": true }, "nullable": true }, "ValidationInformation": { "description": "The current validation state and associated validation errors when state is invalid. When state is valid, it means all referred dependent blueprints and service items are valid. All referred objects are present in the system and available for cloning.", "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.ValidationInformation", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the blueprint to support multiple versions.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "x-createOnly": true, "x-omitempty": true }, "AssociatedRoles": { "description": "An array of relationships to iamRole resources.", "type": "array", "items": { "$ref": "#/components/schemas/iam.Role.Relationship" }, "nullable": true }, "Catalog": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.Catalog.Relationship", "description": "A reference to a workflowCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "workload.Blueprint.List": { "title": "List of 'workload.Blueprint' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workload.Blueprint' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workload.Blueprint' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workload.Blueprint" }, "nullable": true } } } ] }, "workload.BlueprintInputReference": { "title": "Workload:Blueprint Input Reference", "description": "Type to capture the input data for the referred blueprint.", "x-allOf-name": "workload.BlueprintInputReference", "allOf": [ { "$ref": "#/components/schemas/workload.BaseBlueprintReference" } ] }, "workload.BlueprintReference": { "title": "Workload:Blueprint Reference", "description": "Type to capture all details about the blueprint referenced within this workload.", "x-allOf-name": "workload.BlueprintReference", "allOf": [ { "$ref": "#/components/schemas/workload.BaseBlueprintReference" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.BlueprintReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.BlueprintReference" ], "default": "workload.BlueprintReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.BlueprintReference" ], "default": "workload.BlueprintReference", "x-enum-as-string": true }, "InputOverride": { "type": "array", "items": { "description": "The set of JSON paths within the inputs which have override enabled.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "workload.CanaryDeployment": { "title": "Workload:Canary Deployment", "description": "The percentage of instances to which the changes will be rolled out in each step of the deployment.", "x-allOf-name": "workload.CanaryDeployment", "allOf": [ { "$ref": "#/components/schemas/workload.RolloutStrategy" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.CanaryDeployment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.CanaryDeployment" ], "default": "workload.CanaryDeployment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.CanaryDeployment" ], "default": "workload.CanaryDeployment", "x-enum-as-string": true }, "RolloutPercentages": { "type": "array", "items": { "description": "The percentage of instances to which the changes will be rolled out in each step of the deployment.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "workload.ClearWorkloadTag.Response": { "description": "The response body of a HTTP GET request for the 'workload.ClearWorkloadTag' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workload.ClearWorkloadTag' resources.", "x-one-of-name": "workload.ClearWorkloadTag.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workload.ClearWorkloadTag.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workload.ClearWorkloadTag": { "title": "Workload:Clear Workload Tag", "description": "### Overview\nThe ClearWorkloadTag API helps remove the system-defined workload tag from the specified objects. \nThis API should only be used under the guidance of TAC or a System Administrator. \n#### Purpose\nAs part of workload deployment, Policy, Template, and Profile objects are created and managed by the system.\nThese objects are tagged with a system-defined workload tag to prevent users from making direct changes,\neffectively locking them. When a deployment is undeployed, these objects are typically removed, \nas they are fully managed by the system.\nHowever, in some unexpected scenarios, these objects may not be removed during undeployment. \nThe ClearWorkloadTag API is provided to remove workload tags from such objects, allowing users to modify\nthem by unlocking them.\nThis API should only be used under the guidance of TAC or a System Administrator to untag objects and\ndisassociate them from workload tracking.\n#### Key Concepts\n- **Untag Workload Tag:** - Removes the workload tag from all the specified objects.", "x-allOf-name": "workload.ClearWorkloadTag", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.ClearWorkloadTag', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.ClearWorkloadTag" ], "default": "workload.ClearWorkloadTag", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.ClearWorkloadTag" ], "default": "workload.ClearWorkloadTag", "x-enum-as-string": true }, "Objects": { "type": "array", "items": { "description": "The list of objects to be untagged from the workload.", "$ref": "#/components/schemas/mo.MoRef", "x-createOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "workload.ClearWorkloadTag.List": { "title": "List of 'workload.ClearWorkloadTag' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workload.ClearWorkloadTag' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workload.ClearWorkloadTag' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workload.ClearWorkloadTag" }, "nullable": true } } } ] }, "workload.CloneStatus": { "title": "Workload:Clone Status", "description": "The status of the clone operation for workload blueprint inputs, used to track the progress of cloning a workload definition input.", "x-allOf-name": "workload.CloneStatus", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.CloneStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.CloneStatus" ], "default": "workload.CloneStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.CloneStatus" ], "default": "workload.CloneStatus", "x-enum-as-string": true }, "BlueprintRefName": { "description": "The reference name of the blueprint for which the clone operation is being tracked.", "type": "string", "readOnly": true, "x-omitempty": true }, "CloneStatusCounter": { "description": "The count of clone operations performed for the input.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CloneStatusEntry": { "type": "array", "items": { "description": "A collection of clone status entries for the workload blueprint input. Each entry tracks the status of the clone operation for a specific input.", "$ref": "#/components/schemas/workload.CloneStatusEntry", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MoType": { "description": "The managed object type of the input for which the clone operation is being tracked. It is used to identify the type of input data that is being cloned.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the input for which the clone operation is being tracked.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "workload.CloneStatusEntry": { "title": "Workload:Clone Status Entry", "description": "The status of the clone operation for a workload blueprint input. It is used to track the progress of cloning a workload definition.", "x-allOf-name": "workload.CloneStatusEntry", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.CloneStatusEntry', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.CloneStatusEntry" ], "default": "workload.CloneStatusEntry", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.CloneStatusEntry" ], "default": "workload.CloneStatusEntry", "x-enum-as-string": true }, "ClonedObject": { "description": "The input data for the clone operation. It is used to track the input data that was used to clone the workload definition.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "SourceInput": { "description": "The source input data for the clone operation. It is used to track the original input data that is being cloned.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the clone operation for a workload blueprint input.\n* `ToBeCloned` - The clone operation for the workload blueprint input is pending and has not yet started.\n* `Cloned` - The clone operation for the workload blueprint input has been successfully completed.\n* `Failed` - The clone operation for the workload blueprint input has failed due to an error.\n* `InProgress` - The clone operation for the workload blueprint input is currently in progress.", "type": "string", "enum": [ "ToBeCloned", "Cloned", "Failed", "InProgress" ], "default": "ToBeCloned", "readOnly": true, "x-omitempty": true } } } ] }, "workload.DefinitionMapper": { "title": "Workload:Definition Mapper", "description": "Captures the definition and its version to map values for consumers. For example, a WorkloadDeployment references a WorkloadDefinition, containing both the WorkloadDefinition and its version.", "x-allOf-name": "workload.DefinitionMapper", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.DefinitionMapper', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.DefinitionMapper" ], "default": "workload.DefinitionMapper", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.DefinitionMapper" ], "default": "workload.DefinitionMapper", "x-enum-as-string": true }, "DefinitionName": { "description": "The name of the definition being referenced.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Organization": { "description": "The organization to which the definition belongs.", "$ref": "#/components/schemas/mo.MoRef", "x-createOnly": true, "x-omitempty": true }, "UsePreferredVersion": { "description": "Indicates whether this version is the default version of the referenced definition. If set to true, the version should be the default.", "type": "boolean", "x-omitempty": true }, "Version": { "description": "The version number of the referenced definition.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "workload.DeploymentBlueprintInputType": { "title": "Workload:Deployment Blueprint Input Type", "description": "Type to capture the input data for the referred blueprint.", "x-allOf-name": "workload.DeploymentBlueprintInputType", "allOf": [ { "$ref": "#/components/schemas/workload.BaseBlueprintReference" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.DeploymentBlueprintInputType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.DeploymentBlueprintInputType" ], "default": "workload.DeploymentBlueprintInputType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.DeploymentBlueprintInputType" ], "default": "workload.DeploymentBlueprintInputType", "x-enum-as-string": true }, "ExpungedObjects": { "type": "array", "items": { "description": "A list of generated objects that are pending deletion as part of the workload deployment. Once the objects are deleted, they will be removed from the list.", "$ref": "#/components/schemas/workload.GeneratedObject", "readOnly": true, "x-omitempty": true }, "nullable": true }, "GeneratedObjects": { "type": "array", "items": { "description": "A list of generated objects that are created as part of the workload deployment when creating prerequisite objects for service item deployment.", "$ref": "#/components/schemas/workload.GeneratedObject", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "workload.DeploymentChangeDetail": { "title": "Workload:Deployment Change Detail", "description": "Captures details of changes at the workload deployment level.", "x-allOf-name": "workload.DeploymentChangeDetail", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.DeploymentChangeDetail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.DeploymentChangeDetail" ], "default": "workload.DeploymentChangeDetail", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.DeploymentChangeDetail" ], "default": "workload.DeploymentChangeDetail", "x-enum-as-string": true }, "ChangeType": { "description": "The type of change that was applied.\n* `None` - No changes have been made.\n* `InputChange` - A change has been made to an input parameter. For example, an update to the NTP server address.\n* `WorkloadDefinitionChange` - The associated workload definition has changed, such as updating to a new version.\n* `WorkloadPreferredVersionChange` - The deployment was created or updated with the default workload definition version, but the default version was later changed.", "type": "string", "enum": [ "None", "InputChange", "WorkloadDefinitionChange", "WorkloadPreferredVersionChange" ], "default": "None", "readOnly": true, "x-omitempty": true } } } ] }, "workload.DeploymentInput.Response": { "description": "The response body of a HTTP GET request for the 'workload.DeploymentInput' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workload.DeploymentInput' resources.", "x-one-of-name": "workload.DeploymentInput.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workload.DeploymentInput.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workload.DeploymentInput.Relationship": { "description": "A relationship to the 'workload.DeploymentInput' resource, or the expanded 'workload.DeploymentInput' resource, or the 'null' value.", "x-one-of-name": "workload.DeploymentInput.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workload.DeploymentInput" } ], "discriminator": { "propertyName": "ClassId" } }, "workload.DeploymentInput": { "title": "Workload:Deployment Input", "description": "### Overview\nThe DeploymentInput object captures a versioned snapshot of all input parameters and configuration values for a workload deployment at a specific point in time. It maintains a complete history of how deployment inputs have evolved, enabling traceability and potential rollback scenarios.\n#### Purpose\nDeploymentInput serves as an immutable historical record of deployment configuration states. Each time deployment inputs change, a new DeploymentInput object is created with an incremented generation number. This enables the system to track which workload instances were created with which input configurations and to understand the impact of input changes over time.\n#### Key Concepts\n- **Generation-Based Versioning:** - Each input change creates a new generation with an incremented sequence number, providing a complete audit trail of configuration changes.\n- **Input Composition:** - Combines user-provided inputs at both the workload definition and deployment levels, with deployment-level inputs overriding definition-level inputs where applicable.\n- **Blueprint Integration:** - Resolves all blueprint-specific inputs and merges them into a unified input structure that can be applied to workload instance creation.\n- **Object Generation State:** - Tracks whether managed objects (policies, profiles) were successfully generated from this input configuration, supporting rollback scenarios when object generation fails.", "x-allOf-name": "workload.DeploymentInput", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.DeploymentInput', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.DeploymentInput" ], "default": "workload.DeploymentInput", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.DeploymentInput" ], "default": "workload.DeploymentInput", "x-enum-as-string": true }, "GenNumber": { "description": "A sequential number that increments whenever the input changes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Input": { "type": "array", "items": { "description": "The user provided and override input from the policy.", "$ref": "#/components/schemas/workload.DeploymentBlueprintInputType", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ObjectGenerationFailed": { "description": "The state of the object generation performed using this input. If object generation fails, then this is set to true when the generated objects are restored to their prior state.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "WorkloadDeployment": { "$ref": "#/components/schemas/workload.WorkloadDeployment.Relationship", "description": "A reference to a workloadWorkloadDeployment resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "workload.DeploymentInput.List": { "title": "List of 'workload.DeploymentInput' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workload.DeploymentInput' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workload.DeploymentInput' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workload.DeploymentInput" }, "nullable": true } } } ] }, "workload.GeneratedObject": { "title": "Workload:Generated Object", "description": "A generated object that is created as part of the workload deployment when creating prerequisite objects for service item deployment. The generated object is created based on the generated object definition within the blueprint. The base properties for the object come from the blueprint validated configuration and user inputs are plugged into all the relevant properties to form a complete set of objects which can be used for service item instantiation.", "x-allOf-name": "workload.GeneratedObject", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.GeneratedObject', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.GeneratedObject" ], "default": "workload.GeneratedObject", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.GeneratedObject" ], "default": "workload.GeneratedObject", "x-enum-as-string": true }, "Name": { "description": "The name of the generated object as defined in the generated object definition of a blueprint.", "type": "string", "readOnly": true, "x-omitempty": true }, "Objects": { "type": "array", "items": { "description": "A list of references to the objects created during object generation.", "$ref": "#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "workload.RenameRequest": { "title": "Workload:Rename Request", "description": "The request for a rename operation on an object.", "x-allOf-name": "workload.RenameRequest", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.RenameRequest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.RenameRequest" ], "default": "workload.RenameRequest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.RenameRequest" ], "default": "workload.RenameRequest", "x-enum-as-string": true }, "Action": { "description": "The action to be taken for the rename operation on an object.\n* `None` - No action is to be taken for the rename request.\n* `Rename` - The object is to be renamed with the new name in the request.", "type": "string", "enum": [ "None", "Rename" ], "default": "None", "x-omitempty": true }, "NewName": { "description": "The new name for the object. This name will be used to rename all objects associated with it.", "type": "string", "x-omitempty": true }, "Status": { "description": "The status of the rename operation for an object.\n* `None` - No rename operation is in progress, the last rename operation succeeded, or rename has not been performed on the object.\n* `Updating` - The object is currently being renamed.\n* `UpdateScheduled` - The rename request for the object has been accepted and will be processed.", "type": "string", "enum": [ "None", "Updating", "UpdateScheduled" ], "default": "None", "readOnly": true, "x-omitempty": true } } } ] }, "workload.ResourceConstraint": { "title": "Workload:Resource Constraint", "description": "The constraints that need to be applied to the resources in order to match this blueprint.", "x-allOf-name": "workload.ResourceConstraint", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.ResourceConstraint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.ResourceConstraint" ], "default": "workload.ResourceConstraint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.ResourceConstraint" ], "default": "workload.ResourceConstraint", "x-enum-as-string": true }, "Input": { "description": "The input values from the user for the resource definition of the blueprint.", "x-omitempty": true } } } ] }, "workload.RolloutStrategy": { "title": "Workload:Rollout Strategy", "description": "Defines the strategy for rolling out changes to instances.", "x-allOf-name": "workload.RolloutStrategy", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.RolloutStrategy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name 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": [ "workload.BatchDeployment", "workload.CanaryDeployment" ], "x-enum-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": [ "workload.BatchDeployment", "workload.CanaryDeployment" ], "x-enum-as-string": true }, "FailureThreshold": { "description": "Specifies no of errors can be allowed to skip executing next set.", "type": "integer", "format": "int64", "default": 10, "readOnly": true, "x-omitempty": true } } } ] }, "workload.StateAggregation": { "title": "Workload:State Aggregation", "description": "The aggregated state information for a collection of referenced objects, including their overall state and count.", "x-allOf-name": "workload.StateAggregation", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.StateAggregation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.StateAggregation" ], "default": "workload.StateAggregation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.StateAggregation" ], "default": "workload.StateAggregation", "x-enum-as-string": true }, "Count": { "description": "The total number of referenced objects included in the aggregation.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "State": { "description": "The overall aggregated state as a string, summarizing the status of all referenced objects.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "workload.WorkloadDefinition.Response": { "description": "The response body of a HTTP GET request for the 'workload.WorkloadDefinition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workload.WorkloadDefinition' resources.", "x-one-of-name": "workload.WorkloadDefinition.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workload.WorkloadDefinition.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workload.WorkloadDefinition.Relationship": { "description": "A relationship to the 'workload.WorkloadDefinition' resource, or the expanded 'workload.WorkloadDefinition' resource, or the 'null' value.", "x-one-of-name": "workload.WorkloadDefinition.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workload.WorkloadDefinition" } ], "discriminator": { "propertyName": "ClassId" } }, "workload.WorkloadDefinition": { "title": "Workload Definition", "description": "### Overview\nThe WorkloadDefinition object represents the blueprint for defining reusable workload configurations that can be deployed across one or more organizations. It serves as the foundational template that captures the complete specification of a workload, including its associated blueprints, validation requirements, and deployment strategies.\n#### Purpose\nA WorkloadDefinition provides a versioned, reusable specification for workloads that can be deployed multiple times across different contexts organizations. It enables administrators to define complex multi-component workloads once and deploy them consistently, supporting both iterative development through versioning and controlled rollout through deployment strategies.\n#### Key Concepts\n- **Platform Support:** - Platform types can be specified to indicate which Intersight platforms support the workload, ensuring deployments target compatible infrastructure.\n- **Versioning and Preferred Versions:** - Each workload definition supports multiple versions, with the ability to designate a preferred (default) version. This allows for safe evolution of workload specifications while maintaining backward compatibility with existing deployments.\n- **Blueprint Composition:** - Workload definitions are composed of one or more blueprint references, enabling modular design where complex workloads are built from reusable blueprint components.\n- **Validation and Status Tracking:** - Each definition maintains validation information to ensure all required inputs and dependencies are properly configured before deployment, along with deployment summary aggregations across all instances.\n- **Override Inputs:** - Each workload definition can specify input overrides for the blueprints it references, allowing for customization within deployments.", "x-allOf-name": "workload.WorkloadDefinition", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.WorkloadDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.WorkloadDefinition" ], "default": "workload.WorkloadDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.WorkloadDefinition" ], "default": "workload.WorkloadDefinition", "x-enum-as-string": true }, "Blueprints": { "type": "array", "items": { "description": "The set of blueprints referenced within this workload.", "$ref": "#/components/schemas/workload.BlueprintReference", "x-omitempty": true }, "nullable": true }, "DeploymentSummary": { "type": "array", "items": { "description": "An aggregated summary of the states for all workload deployments in this definition.", "$ref": "#/components/schemas/workload.StateAggregation", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Description": { "description": "The description for this workload definition.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "The name for this Workload. You can have multiple versions of the Workload with the same name. Name can only contain letters (a-z, A-Z), numbers (0-9), space, hyphen (-), or an underscore (_). A refName is generated from the given name, and that along with the version must be unique within an Organization.", "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9- _]{0,31}$", "x-createOnly": true, "x-omitempty": true }, "PlatformType": { "type": "array", "items": { "description": "The Intersight platforms supported by this blueprint.\n* `None` - Default value is none, platform is not mentioned.\n* `UnifiedEdge` - The blueprint is created for Unified Edge platform.", "type": "string", "enum": [ "None", "UnifiedEdge" ], "default": "None", "x-omitempty": true }, "nullable": true }, "PreferredVersion": { "description": "The flag to indicate that this is the preferred (default) version of the workload.", "type": "boolean", "default": false, "x-omitempty": true }, "PreferredVersionRolloutStrategy": { "description": "The strategy used for rolling out deployment changes when this workload version is marked as the preferred version.", "$ref": "#/components/schemas/workload.RolloutStrategy", "x-omitempty": true }, "RefName": { "description": "A reference name is generated by the system based on the given name by replacing spaces and hyphen in name with underscore. This reference name is used internally and cannot be edited by users. It may only contain letters (a\u2013z, A\u2013Z), numbers (0\u20139), and underscores (_).", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9_]{0,31}$", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the definition.\n* `Inactive` - The definition is in an inactive state and there are no workload instances associated with this workload. Changes to input parameters within the workload are allowed in this state.\n* `Active` - The definition is active and associated with one or more workload instances.", "type": "string", "enum": [ "Inactive", "Active" ], "default": "Inactive", "x-omitempty": true }, "ValidationInformation": { "description": "The current validation state and associated validation errors when state is invalid. When state is valid, it means all the required inputs for the blueprint are provided.", "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.ValidationInformation", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the workload to support multiple versions.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "x-createOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/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 }, "WorkloadMetadata": { "$ref": "#/components/schemas/workload.WorkloadMetadata.Relationship", "description": "A reference to a workloadWorkloadMetadata resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "workload.WorkloadDefinition.List": { "title": "List of 'workload.WorkloadDefinition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workload.WorkloadDefinition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workload.WorkloadDefinition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workload.WorkloadDefinition" }, "nullable": true } } } ] }, "workload.WorkloadDeployment.Response": { "description": "The response body of a HTTP GET request for the 'workload.WorkloadDeployment' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workload.WorkloadDeployment' resources.", "x-one-of-name": "workload.WorkloadDeployment.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workload.WorkloadDeployment.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workload.WorkloadDeployment.Relationship": { "description": "A relationship to the 'workload.WorkloadDeployment' resource, or the expanded 'workload.WorkloadDeployment' resource, or the 'null' value.", "x-one-of-name": "workload.WorkloadDeployment.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workload.WorkloadDeployment" } ], "discriminator": { "propertyName": "ClassId" } }, "workload.WorkloadDeployment": { "title": "Workload Deployment", "description": "### Overview\nThe WorkloadDeployment object represents an active deployment configuration that creates and manages workload instances based on a workload definition. It defines how a workload should be deployed to specific resources within an organization, including qualification criteria, overriden input parameters, and rollout strategies.\n#### Purpose\nA WorkloadDeployment bridges the gap between a workload definition (the template) and actual workload instances (the running resources). It specifies which resources should receive the workload through qualification criteria, provides deployment-specific configuration overrides, and manages the lifecycle of all workload instances created under its scope.\n#### Key Concepts\n- **Resource Qualification:** - Uses qualification criteria to dynamically determine which resources within an organization should receive the workload deployment, enabling automated scaling and resource targeting.\n- **Instance Naming and Management:** - Automatically generates unique names for workload instances using configurable prefixes and numeric suffixes, maintaining a consistent naming convention across deployments.\n- **Deployment Actions and Status:** - Tracks deployment actions and maintains status information, enabling administrators to monitor and control deployment lifecycle operations.\n- **Change Tracking and Validation:** - Records all configuration changes and maintains validation state to ensure deployments remain properly configured before executing actions.\n- **Conformance Monitoring:** - Continuously monitors whether deployed instances remain in conformance with the deployment specification, detecting and reporting configuration drift.\n- **Rollout Strategy:** - Supports configurable rollout strategies for controlling how changes are propagated to existing workload instances, enabling controlled updates with minimal disruption.\n- **Rename Support:** - Renames a workload deployment through the renameRequest property. This updates the deployment name and all the objects managed by the deployment.", "x-allOf-name": "workload.WorkloadDeployment", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.WorkloadDeployment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.WorkloadDeployment" ], "default": "workload.WorkloadDeployment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.WorkloadDeployment" ], "default": "workload.WorkloadDeployment", "x-enum-as-string": true }, "Action": { "description": "The action is performed on the deployment.\n* `None` - No changes have been made.\n* `PrepareToDeploy` - Marks the deployment as ready once the user has completed all changes and the deployment is in a valid state. Once the deployment is marked as PrepareToDeploy, workload instances will be created, but the actual deployment will occur as part of the deploy action.\n* `Deploy` - Initiates the process of pushing workload configuration to the instances based on the configured schedule. Once deployed, the deployment cannot be reverted to draft status.\n* `Suspend` - Suspends the deployment, preventing any further actions until it is resumed. Making changes to deployment configuration will not be pushed out. The deployment will not take any changes from the attached Workload when it is suspended.\n* `Retry` - Retries the deployment for all instances that previously failed.\n* `Resume` - Resumes a suspended deployment. Any changes made to the deployment when it was suspended or any changes made to the attached Workload will now be pushed out based on configured schedules.\n* `Undeploy` - Undeploy cleans up the policies, templates, and leases generated from the deployment, and marks the deployment as being in the Draft state. The associated definition will be marked as Inactive if there are no other deployments linked to it.\n* `ReEvaluateQualifiers` - Triggers a re-evaluation of resource qualifiers for the deployment to ensure that all associated instances are aligned with the current resource constraints and qualifiers defined in the deployment.", "type": "string", "enum": [ "None", "PrepareToDeploy", "Deploy", "Suspend", "Retry", "Resume", "Undeploy", "ReEvaluateQualifiers" ], "default": "None", "x-omitempty": true }, "Blueprints": { "type": "array", "items": { "description": "The user-provided input values for the deployment.", "$ref": "#/components/schemas/workload.BlueprintInputReference", "x-omitempty": true }, "nullable": true }, "ChangeDetails": { "type": "array", "items": { "description": "Details of changes made to the deployment.", "$ref": "#/components/schemas/workload.DeploymentChangeDetail", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Conformance": { "description": "The conformance status of the deployment.\n* `Ok` - The deployment conforms to the preferred version of the workload.\n* `NonConformant` - The deployment does not conform to the preferred version of the workload.", "type": "string", "enum": [ "Ok", "NonConformant" ], "default": "Ok", "readOnly": true, "x-omitempty": true }, "Description": { "description": "A brief description of the deployment.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "DigitCount": { "description": "The minimum digit count to format the instance index with leading zeros, for example if the digit count is 4 and the start index is 1, then the first instance will have a suffix 0001. If the number of instances created for the deployment exceeds the 9999, then the suffix will become a 5 digit number.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 4, "x-omitempty": true }, "InstanceConformanceSummary": { "type": "array", "items": { "description": "A summary of the conformance statuses of all workload instances in this deployment. It includes the overall conformance state and the total count of instances for each conformance state.", "$ref": "#/components/schemas/workload.StateAggregation", "readOnly": true, "x-omitempty": true }, "nullable": true }, "InstanceStatusSummary": { "type": "array", "items": { "description": "A summary of the states of all workload instances in this deployment. It includes the overall state and the total count of instances for each state.", "$ref": "#/components/schemas/workload.StateAggregation", "readOnly": true, "x-omitempty": true }, "nullable": true }, "LastAction": { "description": "The last action is performed on the deployment.\n* `None` - No changes have been made.\n* `PrepareToDeploy` - Marks the deployment as ready once the user has completed all changes and the deployment is in a valid state. Once the deployment is marked as PrepareToDeploy, workload instances will be created, but the actual deployment will occur as part of the deploy action.\n* `Deploy` - Initiates the process of pushing workload configuration to the instances based on the configured schedule. Once deployed, the deployment cannot be reverted to draft status.\n* `Suspend` - Suspends the deployment, preventing any further actions until it is resumed. Making changes to deployment configuration will not be pushed out. The deployment will not take any changes from the attached Workload when it is suspended.\n* `Retry` - Retries the deployment for all instances that previously failed.\n* `Resume` - Resumes a suspended deployment. Any changes made to the deployment when it was suspended or any changes made to the attached Workload will now be pushed out based on configured schedules.\n* `Undeploy` - Undeploy cleans up the policies, templates, and leases generated from the deployment, and marks the deployment as being in the Draft state. The associated definition will be marked as Inactive if there are no other deployments linked to it.\n* `ReEvaluateQualifiers` - Triggers a re-evaluation of resource qualifiers for the deployment to ensure that all associated instances are aligned with the current resource constraints and qualifiers defined in the deployment.", "type": "string", "enum": [ "None", "PrepareToDeploy", "Deploy", "Suspend", "Retry", "Resume", "Undeploy", "ReEvaluateQualifiers" ], "default": "None", "readOnly": true, "x-omitempty": true }, "LastInstanceIndex": { "description": "Tracks the last numeric index used for workload instances. The next instance index is derived by incrementing this value.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name for this Deployment. Name can only contain letters (a-z, A-Z), numbers (0-9), space, hyphen (-), or an underscore (_). The name must be unique within the organization.", "type": "string", "pattern": "^[a-zA-Z0-9][a-zA-Z0-9- _]{0,31}$", "x-createOnly": true, "x-omitempty": true }, "Qualifiers": { "type": "array", "items": { "description": "The qualification criteria applied to the deployment.", "$ref": "#/components/schemas/resource.ResourceQualifier", "x-omitempty": true }, "nullable": true }, "RefName": { "description": "A reference name is generated by the system based on the given name by replacing spaces and hyphen in name with underscore. This reference name is used internally and cannot be edited by users. It may only contain letters (a\u2013z, A\u2013Z), numbers (0\u20139), and underscores (_).", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9_]{0,31}$", "readOnly": true, "x-omitempty": true }, "RenameRequest": { "description": "The request for the renaming operation on the workload deployment object.", "$ref": "#/components/schemas/workload.RenameRequest", "x-omitempty": true }, "RolloutStrategy": { "description": "The strategy used for rolling out deployment changes.", "$ref": "#/components/schemas/workload.RolloutStrategy", "x-omitempty": true }, "StartIndexForSuffix": { "description": "The starting index used to generate the suffix for the workload instance name.", "type": "integer", "format": "int64", "default": 1, "x-createOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the deployment.\n* `Draft` - The initial state of the deployment, indicating it is still being configured and not ready for deployment.\n* `ReadyToDeploy` - The deployment has passed validation checks and is ready to be deployed to instances.\n* `InProgress` - The initial deployment or changes in the deployment are in progress.\n* `Ok` - All associated instances have been successfully deployed.\n* `Failed` - One or more instances failed during initial deployment or changes in the deployment operations.\n* `ChangesScheduled` - The deployment has changes that need to be pushed to all associated instances.\n* `Suspended` - The deployment is suspended, preventing any further initial deployments or changes to deployment operations.", "type": "string", "enum": [ "Draft", "ReadyToDeploy", "InProgress", "Ok", "Failed", "ChangesScheduled", "Suspended" ], "default": "Draft", "readOnly": true, "x-omitempty": true }, "ValidationInformation": { "description": "Validation details and status of the deployment.", "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.ValidationInformation", "readOnly": true, "x-omitempty": true }, "WorkloadDefinitionReference": { "description": "The workload definition associated with this deployment.", "$ref": "#/components/schemas/workload.DefinitionMapper", "x-omitempty": true }, "WorkloadInstancePrefix": { "description": "The prefix to be used for naming workload instances created by this deployment. Prefix can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), or an underscore (_). This prefix must be unique within the organization.", "type": "string", "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9-_]{0,31}$", "x-omitempty": true }, "DeploymentInput": { "$ref": "#/components/schemas/workload.DeploymentInput.Relationship", "description": "A reference to a workloadDeploymentInput resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DeploymentInputHistory": { "description": "An array of relationships to workloadDeploymentInput resources.", "type": "array", "items": { "$ref": "#/components/schemas/workload.DeploymentInput.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "#/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 }, "QualificationPolicies": { "description": "An array of relationships to resourceAbstractResourceQualificationPolicy resources.", "type": "array", "items": { "$ref": "#/components/schemas/resource.AbstractResourceQualificationPolicy.Relationship" }, "nullable": true, "readOnly": true }, "ResourcePool": { "$ref": "#/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.", "readOnly": true }, "SchedulePolicy": { "$ref": "#/components/schemas/scheduler.SchedulePolicy.Relationship", "description": "A reference to a schedulerSchedulePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "TaskSchedule": { "$ref": "#/components/schemas/scheduler.TaskSchedule.Relationship", "description": "A reference to a schedulerTaskSchedule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "WorkloadDefinition": { "$ref": "#/components/schemas/workload.WorkloadDefinition.Relationship", "description": "A reference to a workloadWorkloadDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "workload.WorkloadDeployment.List": { "title": "List of 'workload.WorkloadDeployment' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workload.WorkloadDeployment' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workload.WorkloadDeployment' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workload.WorkloadDeployment" }, "nullable": true } } } ] }, "workload.WorkloadInstance.Response": { "description": "The response body of a HTTP GET request for the 'workload.WorkloadInstance' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workload.WorkloadInstance' resources.", "x-one-of-name": "workload.WorkloadInstance.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workload.WorkloadInstance.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workload.WorkloadInstance": { "title": "Workload Instance", "description": "### Overview\nThe WorkloadInstance object represents a single deployed instance of a workload, created and managed by a workload deployment. It captures the runtime state, assigned resources, and lifecycle operations for an individual workload deployment target.\n#### Purpose\nA WorkloadInstance is the concrete manifestation of a workload definition deployed to specific infrastructure resources. It tracks the operational state of the deployment on those resources, manages lifecycle actions, and monitors conformance with the desired state defined by its parent deployment.\n#### Key Concepts\n- **Resource Assignment:** - Each instance is bound to specific infrastructure resources (chassis, servers, etc.) assigned during creation, maintaining references to those resources throughout its lifecycle.\n- **Status and Action Management:** - Maintains current operational status and tracks the last action performed, while also accepting new action requests to change the instance state.\n- **Change Type Tracking:** - Identifies what types of changes have occurred in the deployment or workload definition that have not yet been applied to this instance, supporting intelligent update operations.\n- **Conformance Monitoring:** - Continuously monitors whether the actual deployed configuration matches the desired state, detecting and reporting drift that may occur through out-of-band changes.\n- **Service Item Integration:** - Maintains relationships to service item instances that implement the actual deployment workflows, bridging workload-level abstractions with underlying service implementation.", "x-allOf-name": "workload.WorkloadInstance", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.WorkloadInstance', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.WorkloadInstance" ], "default": "workload.WorkloadInstance", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.WorkloadInstance" ], "default": "workload.WorkloadInstance", "x-enum-as-string": true }, "Action": { "description": "The action to be performed on the workload instance.\n* `None` - Absence of any action on the workload instance.\n* `Suspend` - Pauses the execution of the workload instance, temporarily stopping its operations without permanently removing it.\n* `Resume` - Restarts a suspended workload instance, allowing it to continue operations from where it left off.\n* `Deploy` - Initiates the deployment of the workload instance, provisioning the necessary resources and starting its execution.\n* `Retry` - Attempts to re-deploy the workload instance, either due to a previous failure or to apply changes made to the instance.\n* `RetryAll` - Attempts to re-deploy all workload instances associated with the same deployment, either due to a previous failure or to apply changes made to the instances.\n* `Attach` - Associates the workload instance with its assigned resources, allowing it to utilize the resources for its operations.\n* `Detach` - Disassociates the workload instance from its assigned resources, preventing it from using the resources for its operations.\n* `UnAssign` - Detaches assigned resources from the workload instance while keeping the instance active.", "type": "string", "enum": [ "None", "Suspend", "Resume", "Deploy", "Retry", "RetryAll", "Attach", "Detach", "UnAssign" ], "default": "None", "x-omitempty": true }, "AlarmSummary": { "description": "A summary of active and acknowledged alarms for this workload instance, grouped by severity (for example, Critical, Major, Minor, Warning, Info). This summary includes both suppressed and unsuppressed alarms.", "$ref": "intersight-server-v3-1.0.11-20260807064027971.json#/components/schemas/compute.AlarmSummary", "readOnly": true, "x-omitempty": true }, "AssignedResources": { "type": "array", "items": { "description": "The resources assigned to the workload instance during creation.", "$ref": "#/components/schemas/workload.AssignedResource", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ChangeTypes": { "type": "array", "items": { "description": "The type of changes made to the deployment or workload that have not yet been applied.\n* `None` - No changes have been made.\n* `InputChange` - A change has been made to an input parameter. For example, an update to the NTP server address.\n* `WorkloadDefinitionChange` - The associated workload definition has changed, such as updating to a new version.\n* `WorkloadPreferredVersionChange` - The deployment was created or updated with the default workload definition version, but the default version was later changed.", "type": "string", "enum": [ "None", "InputChange", "WorkloadDefinitionChange", "WorkloadPreferredVersionChange" ], "default": "None", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Conformance": { "description": "The conformance status of the deployment.\n* `Ok` - The deployment conforms to the preferred version of the workload.\n* `NonConformant` - The deployment does not conform to the preferred version of the workload.", "type": "string", "enum": [ "Ok", "NonConformant" ], "default": "Ok", "readOnly": true, "x-omitempty": true }, "LastAction": { "description": "The last action performed on the workload instance.\n* `None` - Absence of any action on the workload instance.\n* `Suspend` - Pauses the execution of the workload instance, temporarily stopping its operations without permanently removing it.\n* `Resume` - Restarts a suspended workload instance, allowing it to continue operations from where it left off.\n* `Deploy` - Initiates the deployment of the workload instance, provisioning the necessary resources and starting its execution.\n* `Retry` - Attempts to re-deploy the workload instance, either due to a previous failure or to apply changes made to the instance.\n* `RetryAll` - Attempts to re-deploy all workload instances associated with the same deployment, either due to a previous failure or to apply changes made to the instances.\n* `Attach` - Associates the workload instance with its assigned resources, allowing it to utilize the resources for its operations.\n* `Detach` - Disassociates the workload instance from its assigned resources, preventing it from using the resources for its operations.\n* `UnAssign` - Detaches assigned resources from the workload instance while keeping the instance active.", "type": "string", "enum": [ "None", "Suspend", "Resume", "Deploy", "Retry", "RetryAll", "Attach", "Detach", "UnAssign" ], "default": "None", "readOnly": true, "x-omitempty": true }, "LocationDetails": { "description": "LocationDetails is the location assigned to the resource referenced by AssignedResources. Location is assigned to resources by a user via its related Target.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.GeoLocationDetails", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name for this Workload instance.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The current status of the workload instance.\n* `Staging` - The instance is in the staging phase, awaiting further actions.\n* `ReadyToDeploy` - The instance is fully configured and ready for deployment.\n* `InProgress` - Deployment or modification of the instance is currently in progress.\n* `Ok` - The instance is running successfully without issues.\n* `Failed` - The instance has encountered an error or failure preventing normal operation.\n* `Suspended` - The instance has been temporarily paused and is inactive.\n* `ChangesScheduled` - There is a change in the configuration that needs to be pushed to the instance.\n* `InSufficientResource` - The instance lacks the necessary resources to operate.\n* `OutOfService` - The instance is no longer available or operational.\n* `UnAssigning` - The instance is being unassigned or removed from service.\n* `Detaching` - The instance is currently being detached. During the process, the managed objects created by workload will be unlocked. This means for a Unified edge workload, the unified edge profile and server profile will be unlocked and detached from the source template created by workload so users can make changes to those profiles.\n* `Attaching` - The instance is currently being attached to the deployment. The managed objects created by the workload will no longer be available for modifications.", "type": "string", "enum": [ "Staging", "ReadyToDeploy", "InProgress", "Ok", "Failed", "Suspended", "ChangesScheduled", "InSufficientResource", "OutOfService", "UnAssigning", "Detaching", "Attaching" ], "default": "Staging", "readOnly": true, "x-omitempty": true }, "StatusChangeReason": { "description": "The context or justification for the status transition.\n* `None` - No changes have been made.\n* `ResourceDisqualified` - The change in resource status triggered due to the resource being disqualified.", "type": "string", "enum": [ "None", "ResourceDisqualified" ], "default": "None", "readOnly": true, "x-omitempty": true }, "ChassisPoolMember": { "$ref": "#/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 }, "DeploymentInput": { "$ref": "#/components/schemas/workload.DeploymentInput.Relationship", "description": "A reference to a workloadDeploymentInput resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LastDeploymentInput": { "$ref": "#/components/schemas/workload.DeploymentInput.Relationship", "description": "A reference to a workloadDeploymentInput resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "#/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 }, "ServiceItemInstances": { "description": "An array of relationships to workflowServiceItemInstance resources.", "type": "array", "items": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.ServiceItemInstance.Relationship" }, "nullable": true, "readOnly": true }, "WorkloadDefinition": { "$ref": "#/components/schemas/workload.WorkloadDefinition.Relationship", "description": "A reference to a workloadWorkloadDefinition resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "WorkloadDeployment": { "$ref": "#/components/schemas/workload.WorkloadDeployment.Relationship", "description": "A reference to a workloadWorkloadDeployment resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "workload.WorkloadInstance.List": { "title": "List of 'workload.WorkloadInstance' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workload.WorkloadInstance' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workload.WorkloadInstance' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workload.WorkloadInstance" }, "nullable": true } } } ] }, "workload.WorkloadMetadata.Response": { "description": "The response body of a HTTP GET request for the 'workload.WorkloadMetadata' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'workload.WorkloadMetadata' resources.", "x-one-of-name": "workload.WorkloadMetadata.Response", "oneOf": [ { "$ref": "#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/workload.WorkloadMetadata.List" }, { "$ref": "#/components/schemas/mo.AggregateTransform" }, { "$ref": "#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "workload.WorkloadMetadata.Relationship": { "description": "A relationship to the 'workload.WorkloadMetadata' resource, or the expanded 'workload.WorkloadMetadata' resource, or the 'null' value.", "x-one-of-name": "workload.WorkloadMetadata.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/workload.WorkloadMetadata" } ], "discriminator": { "propertyName": "ClassId" } }, "workload.WorkloadMetadata": { "title": "WorkloadMetadata", "description": "### Overview\nThe WorkloadMetadata holds version agnostic information about a workload definition. It serves as a statistical summary and aggregation container for workload definitions. WorkloadMetadata provides a centralized view of deployment states and conformance status across all deployments associated with a specific workload definition.\n#### Purpose\nWorkloadMetadata exists to provide efficient access to aggregated metrics and state information for workload definitions without requiring clients to query and aggregate data from individual deployments. This improves performance and provides a consistent view of workload health across the organization.\n#### Key Concepts\n- **Deployment Summary Aggregation:** - Maintains real-time aggregated counts of deployment states across all workload deployments associated with the definition.\n- **Conformance Summary Aggregation:** - Tracks conformance states across deployments, helping administrators understand compliance and drift status at the workload definition level.\n- **Rename Support:** - Renames a workload definition through the renameRequest property. This updates the definition name and all associated workload objects across all versions of the workload definition.", "x-allOf-name": "workload.WorkloadMetadata", "allOf": [ { "$ref": "#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'workload.WorkloadMetadata', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "workload.WorkloadMetadata" ], "default": "workload.WorkloadMetadata", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "workload.WorkloadMetadata" ], "default": "workload.WorkloadMetadata", "x-enum-as-string": true }, "ConformanceSummary": { "type": "array", "items": { "description": "Aggregated summary of conformance states for all workload deployments associated with this definition.", "$ref": "#/components/schemas/workload.StateAggregation", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DeploymentSummary": { "type": "array", "items": { "description": "Aggregated summary of deployment states for all workload deployments associated with this definition.", "$ref": "#/components/schemas/workload.StateAggregation", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RenameRequest": { "description": "The request for the renaming operation on the workload definition object.", "$ref": "#/components/schemas/workload.RenameRequest", "x-omitempty": true }, "WorkloadRefName": { "description": "Reference name for the workload, generated by the system and used internally for identification.", "type": "string", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "#/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 } } } ] }, "workload.WorkloadMetadata.List": { "title": "List of 'workload.WorkloadMetadata' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'workload.WorkloadMetadata' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'workload.WorkloadMetadata' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/workload.WorkloadMetadata" }, "nullable": true } } } ] }, "x509.Certificate": { "title": "X509:Certificate", "description": "The representation of an X.509 certificate.", "x-allOf-name": "x509.Certificate", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'x509.Certificate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "x509.Certificate" ], "default": "x509.Certificate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "x509.Certificate" ], "default": "x509.Certificate", "x-enum-as-string": true }, "Issuer": { "description": "The X.509 distinguished name of the issuer of this certificate.", "$ref": "#/components/schemas/pkix.DistinguishedName", "readOnly": true, "x-omitempty": true }, "NotAfter": { "description": "The date on which the certificate's validity period ends.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "NotBefore": { "description": "The date on which the certificate's validity period begins.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "PemCertificate": { "description": "The base64 encoded certificate in PEM format.", "type": "string", "x-omitempty": true }, "Sha256Fingerprint": { "description": "The computed SHA-256 fingerprint of the certificate. Equivalent to 'openssl x509 -fingerprint -sha256'.", "type": "string", "readOnly": true, "x-omitempty": true }, "SignatureAlgorithm": { "description": "Signature algorithm, as specified in [RFC 5280](https://tools.ietf.org/html/rfc5280).", "type": "string", "readOnly": true, "x-omitempty": true }, "Subject": { "description": "The X.509 distinguished name of the subject of this certificate.", "$ref": "#/components/schemas/pkix.DistinguishedName", "readOnly": true, "x-omitempty": true } } } ] }, "DisplayNames": { "type": "object", "nullable": true, "description": "A set of display names for the MO resource. These names are calculated based on other properties of the\nMO and potentially properties of Ancestor MOs. Displaynames are intended as a way to provide a normalized\nuser appropriate name for an MO, especially for MOs which do not have a 'Name' property, which is the case\nfor much of the inventory discovered from managed targets.\nThere are a limited number of keys, currently 'short', 'hierarchical', and 'auditlog'. The value is an array and clients\nshould use the first element of the array.", "readOnly": true, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "mo.BaseResponse": { "description": "The base response schema.", "type": "object", "discriminator": { "propertyName": "ObjectType" }, "required": [ "ObjectType" ], "properties": { "ObjectType": { "description": "A discriminator value to disambiguate the schema of a HTTP GET response body.", "type": "string" } } }, "mo.AggregateTransform": { "description": "The output of a request that includes the $apply query parameter.\nThe schema of an aggregation query is dynamically determined based on the request query parameters. \nSee https://intersight.com/apidocs/introduction/query/#apply-query-option for more details.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Results": { "description": "The results of the aggregation query.", "type": "array", "items": { "description": "A result entry in the aggregate query.", "type": "object" }, "nullable": true } } } ] }, "mo.DocumentCount": { "description": "A document returned in a response body when the HTTP GET request specifies the '$count' query parameter.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of resources matching the query filter, accross all pages.", "type": "integer", "format": "int32" } } } ] }, "mo.TagKeySummary": { "type": "object", "description": "A summary of the Tag usage for an API resource. Tags are Key, Value pairs that can be assigned to API resources.", "properties": { "Key": { "type": "string", "description": "The tag key for which usage information is provided." }, "NumKeys": { "description": "The number of times this tag Key has been set in an API resource.", "type": "integer", "format": "int32" }, "Values": { "type": "array", "description": "A list of all Tag values that have been assigned to this tag Key.", "items": { "type": "string" } } } }, "mo.TagSummary": { "description": "A document returned in a response body when the HTTP GET request specifies the 'tag' query parameter.", "allOf": [ { "$ref": "#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "ObjectType": { "description": "A discriminator value to disambiguate the schema of a HTTP GET response body.", "type": "string" }, "Results": { "type": "array", "items": { "$ref": "#/components/schemas/mo.TagKeySummary" }, "nullable": true } } } ] }, "PatchDocument": { "type": "object", "description": "A JSONPatch document as defined by RFC 6902. A JSONPatch document can be used in a request body when the 'Content-Type' HTTP header is set to 'application/json-patch+json'.", "required": [ "op", "path" ], "externalDocs": { "description": "Intersight API documentation of supported HTTP methods.", "url": "/apidocs/introduction/methods/" }, "properties": { "op": { "type": "string", "description": "The PATCH operation to be performed. 'move' and 'copy' are defined in RFC 6902 but are not supported in the Intersight API.", "enum": [ "add", "remove", "replace", "move", "copy", "test" ] }, "path": { "type": "string", "description": "A JSON-Pointer to a property in a REST resource." }, "value": { "type": "object", "description": "The value to be used within the operations." }, "from": { "type": "string", "description": "A string containing a JSON Pointer value." } } }, "Error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "A value that is used to determine the nature of the error, and why it occurred.", "enum": [ "InternalServerError", "InvalidMethod", "InvalidUrl", "InvalidRequest", "NotFound", "NotSupported", "NotImplemented", "AuthenticationFailure", "UnauthorizedOperation", "ValidationConflict", "ServiceUnavailable" ] }, "messageId": { "type": "string", "description": "A language-independent identifier of the specific error message." }, "message": { "type": "string", "description": "A human-readable description of the error, localized with the i18n standard.\nThe language is determined from the \"Accept-Language\" request-header.\nThe Accept-Language request-header restricts the set of natural languages that are preferred as a response\nto the request. See RFC 2616 for more details.\nCodes:\n1. **InternalServerError** An internal error occurred.\n1. **InvalidMethod** The HTTP method (POST, PUT...) is invalid for this API path. For example, a POST request was sent but this API path only supports GET.\n1. **InvalidUrl** The HTTP request contains an invalid URL.\n1. **InvalidRequest** The HTTP request contains an invalid or malformed message body.\n1. **NotSupported** The request is not supported for the specified REST resource.\n1. **NotImplemented** This API path is experimental and not implemented yet.\n1. **NotFound** The requested REST resource does not exist.\n1. **AuthenticationFailure** The request lacks valid authentication credentials.\n1. **UnauthorizedOperation** The client is not authorized to perform the operation, such as when the user has insufficient privileges.\n1. **ValidationConflict** The request contains conflicting attributes, such as two mutually exclusive attribute values.\n1. **ServiceUnavailable** See RFC 7231, status 503." }, "cause": { "description": "The cause of this error.", "$ref": "#/components/schemas/Error" } } }, "CsvFile": { "type": "string", "description": "The content is a comma-separated list of values.", "format": "binary" }, "ExcelFile": { "description": "The content is an Excel spreadsheet.", "type": "string", "format": "binary" } }, "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": "#/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": "#/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": "#/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": "#/components/schemas/Error" } } } }, "default": { "description": "An unexpected error occurred.", "headers": { "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/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." } } } } } } }